1. Introduction
The Mobile domain gives you access to specific APIs for the Akuiteo Mobile Application that works off line. These are synchronization APIs that enable you to retrieve details about expense reports, leave requests, timesheets and so on, and also to send back the data to be saved.
1.2. URI Scheme
BasePath : https://api.akuiteo.fr/mobile
1.3. Tags
-
Async Expense Reports : Expense reports Management
-
Async Leaves : Leaves Management (Async)
-
Calendar Event : Calendar event Management
-
Commands : Commands Management
-
Default Activities : Default activities Management
-
MobDocuments : Document Management for cell phone
-
Mobile Subscription : Mobile Subscription management API
-
Setup : Setup Management
-
Sync Assignments : Assignments Management (Synchronous)
-
Sync Custom Requests : Custom requests Management (Synchronous)
-
Sync Documents : Documents Management (Synchronous)
-
Sync Expense Reports : Expense reports Management (Synchronous)
-
Sync Leaves : Leaves Management (Synchronous)
-
Sync Remote work entries : Remote work entries Management (Synchronous)
-
Sync Schedules : Schedules Management (Synchronous)
-
Sync Setup : Setup Management (Synchronous)
-
Sync Timesheet Quick Entries : Timesheet Quick Entries Management (Synchronous)
-
Sync Timesheets : Timesheets Management (Synchronous)
-
User : User Information Management
-
Versions : Versions Management
1.4. Schemas Types
Data types of a schema can be :
-
string (date-time) : the date-time notation as defined by RFC 3339 (
yyyy-MM-dd’T’HH:mm:ss.SSSXXX). e.g. "2020-11-29T08:10:10+0200" -
number : Any numbers.
-
number (double) : Floating-point numbers with double precision. e.g. 10.8
-
number (float) : Floating-point numbers. e.g. 10.8
-
integer (int64) : Signed 64-bit integers (long type). e.g. 10
-
boolean : Represents two values: true and false. Note that truthy and falsy values such as "true", "", 0 or null are not considered boolean values.
2. Resources
2.1. Async Expense Reports
2.1.1. Get Expense reports
GET |
/expense_reports |
Description
Get Expense reports
DMF required:
-
USERAK: A registered user.
Return Type
array[MobNdf]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense Reports retrieved successfully |
List[MobNdf] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.1.2. SmartScan
POST |
/expenses/smart-scan |
Description
SmartScan
DMF required:
-
USERAK: A registered user.
Parameters
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
content |
The image to scan. [file] |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
SmartScan successful expense deduced |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.1.3. Post Expense reports
POST |
/expense_reports |
Description
Post Expense reports
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expenses |
Expenses to update MobNdf |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense Reports successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"validated" : true,
"ident" : 1,
"description" : "Lorem ipsum",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"finished" : true,
"vatInclAmount" : 1,
"currencyCode" : "EUR",
"datCre" : "2020-01-23T04:56:07Z",
"expenses" : [ {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"identExpReport" : 1,
"expenseDate" : "2020-01-23T04:56:07Z",
"datCre" : "2020-01-23T04:56:07Z",
"amount" : 1,
"amountCurrency" : 1,
"title" : "Lorem ipsum",
"complementName" : "Lorem ipsum",
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"validated" : true,
"finished" : true,
"hasDocuments" : true,
"vat1" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vatAmount1" : 1,
"vatAmount2" : 1,
"vatAmount3" : 1,
"type" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"engineTaxRate" : {
"ident" : 1,
"power" : 1,
"price" : 1,
"expenseTypeId" : 1,
"expenceTypeCode" : "ABC",
"code" : "ABC",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z"
},
"rebillable" : true,
"notRefundable" : true,
"receiptNb" : "123",
"kilometer" : 1,
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"guests" : [ {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
}, {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
} ],
"businessCard" : true,
"dateOfDenial" : "2020-01-23T04:56:07Z",
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"quantity" : 1,
"parts" : 2,
"amountCategory" : "{}",
"unitPrice" : 1,
"unitPriceCurrency" : 1,
"afterTaxAmountRefunded" : 1,
"afterTaxCurrencyAmountRefunded" : 1,
"smartScan" : true,
"amountWithoutVat" : 1,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "ABC123",
"employee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"endDate" : "2020-01-23T04:56:07Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"isDuplicateExpenseForSameEmployee" : true,
"isDuplicateExpenseForSeveralEmployee" : true,
"isExpenseOnEmployeeNonWorkingDay" : true,
"isExpenseOnEmployeeLeaveDay" : true
}, {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"identExpReport" : 1,
"expenseDate" : "2020-01-23T04:56:07Z",
"datCre" : "2020-01-23T04:56:07Z",
"amount" : 1,
"amountCurrency" : 1,
"title" : "Lorem ipsum",
"complementName" : "Lorem ipsum",
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"validated" : true,
"finished" : true,
"hasDocuments" : true,
"vat1" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vatAmount1" : 1,
"vatAmount2" : 1,
"vatAmount3" : 1,
"type" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"engineTaxRate" : {
"ident" : 1,
"power" : 1,
"price" : 1,
"expenseTypeId" : 1,
"expenceTypeCode" : "ABC",
"code" : "ABC",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z"
},
"rebillable" : true,
"notRefundable" : true,
"receiptNb" : "123",
"kilometer" : 1,
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"guests" : [ {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
}, {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
} ],
"businessCard" : true,
"dateOfDenial" : "2020-01-23T04:56:07Z",
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"quantity" : 1,
"parts" : 2,
"amountCategory" : "{}",
"unitPrice" : 1,
"unitPriceCurrency" : 1,
"afterTaxAmountRefunded" : 1,
"afterTaxCurrencyAmountRefunded" : 1,
"smartScan" : true,
"amountWithoutVat" : 1,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "ABC123",
"employee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"endDate" : "2020-01-23T04:56:07Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"isDuplicateExpenseForSameEmployee" : true,
"isDuplicateExpenseForSeveralEmployee" : true,
"isExpenseOnEmployeeNonWorkingDay" : true,
"isExpenseOnEmployeeLeaveDay" : true
} ]
}
2.2. Async Leaves
2.2.1. Get leaves' rights
GET |
/leaves/rights |
Description
Get leaves' rights
DMF required:
-
USERAK: A registered user.
Return Type
array[MobLeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves retrieved successfully |
List[MobLeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.2. Get leaves
GET |
/leaves |
Description
Get leaves
DMF required:
-
USERAK: A registered user.
Return Type
array[MobLeave]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves retrieved successfully |
List[MobLeave] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.2.3. Post leaves
POST |
/leaves |
Description
Post leaves
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leaves |
Leaves to update MobLeave |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Leaves successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"id" : "5000130",
"leaveRightId" : "5000130",
"requestDate" : "2020-01-23T04:56:07Z",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"duration" : 1,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"startAfterNoon" : true,
"commentValidator" : "Lorem ipsum",
"dateValidator" : "2020-01-23T04:56:07Z",
"employeeValidator" : "Lorem"
}
2.3. Calendar Event
2.3.1. Get calendar events
GET |
/calendarevent |
Description
Get calendar events
DMF required:
-
USERAK: A registered user.
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Calendar events retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.3.2. Post calendar events
POST |
/calendarevent |
Description
Post calendar events
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
events |
Calendar events to update MobCalendarEvents |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Calendar events successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"timesheetEntries" : [ {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"action2" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem"
},
"completionDate" : "2020-01-23T04:56:07Z"
}, {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"action2" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem"
},
"completionDate" : "2020-01-23T04:56:07Z"
} ],
"schedules" : [ {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"planningAction" : "{}",
"descriptive" : "Lorem ipsum",
"validated" : true,
"leave" : true,
"siteId" : "5000130",
"onlineMeeting" : false,
"endDate" : "2020-01-23T04:56:07Z",
"dayPart" : 1,
"dayMode" : true,
"color" : "#ff0000"
}, {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"planningAction" : "{}",
"descriptive" : "Lorem ipsum",
"validated" : true,
"leave" : true,
"siteId" : "5000130",
"onlineMeeting" : false,
"endDate" : "2020-01-23T04:56:07Z",
"dayPart" : 1,
"dayMode" : true,
"color" : "#ff0000"
} ]
}
2.4. Commands
2.4.1. Execute commands
POST |
/commands |
Description
Execute commands
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
commands |
Setup to update MobCommand |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Command successfully executed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"ident" : 1,
"type" : "{}",
"date" : "2020-01-23T04:56:07Z",
"data" : "data",
"hasBeenProcessed" : true
}
2.4.2. Get Commands
GET |
/commands |
Description
Get Commands
DMF required:
-
USERAK: A registered user.
Return Type
array[MobCommand]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Commands retrieved successfully |
List[MobCommand] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5. Default Activities
2.5.1. Get default activities
GET |
/default_activity |
Description
Get default activities
DMF required:
-
USERAK: A registered user.
Return Type
array[MobActiviteParDefaut]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Default Activities retrieved successfully |
List[MobActiviteParDefaut] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.5.2. Post default activities
POST |
/default_activity |
Description
Post default activities
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
activities |
Default activities to update MobActiviteParDefaut |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Default Activities successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000130",
"description" : "Lorem ipsum",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"action2" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem"
},
"comment" : "Lorem ipsum",
"location" : "27 Rue Auguste Comte, 69002 Lyon, France",
"duration" : 1
}
2.6. Mob Documents
2.6.1. Get document
GET |
/documents/{document_id} |
Description
Get document
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document_id |
The id of the document |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Document retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.6.2. Post document
POST |
/documents/{document_id} |
Description
Post document
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document_id |
The id of the document |
X |
null |
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
content |
The file to upload. [file] |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
type |
Id of the type of document |
- |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Document successfully updated |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.7. Mobile Subscription
2.7.1. Check if subscription is authorized
POST |
/subscriptions/check-authorization |
Description
Check if subscription is authorized
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subscription |
Subscription to check authorization Subscription |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
True if subscription is allowed, false else |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"excludeMyOwnEvents" : true,
"topic" : {
"action" : "ADD",
"id" : "id"
},
"token" : "ciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
2.7.2. Subscription to events
POST |
/subscriptions/subscribe |
Description
Subscription to events
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subscription |
Subscription to subscribe Subscription |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Subscribe successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"excludeMyOwnEvents" : true,
"topic" : {
"action" : "ADD",
"id" : "id"
},
"token" : "ciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
2.7.3. Unsubscription to events
POST |
/subscriptions/unsubscribe |
Description
Unsubscription to events
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
subscription |
Subscription to unsubscribe Subscription |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Subscribe successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"excludeMyOwnEvents" : true,
"topic" : {
"action" : "ADD",
"id" : "id"
},
"token" : "ciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
}
2.8. Setup
2.8.1. Get setup
GET |
/setup |
Description
Get setup
DMF required:
-
USERAK: A registered user.
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
type |
Heavy loading |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Setup retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.8.2. Get parametrage Hash
GET |
/parametrage-hash |
Description
Get parametrage Hash
DMF required:
-
USERAK: A registered user.
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Hash param retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.8.3. Post setup
POST |
/setup |
Description
Post setup
DMF required:
-
USERAK: A registered user.
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
param |
Setup to update MobUpdateParametrage |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Setup updated successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"actions" : [ {
"action" : "Lorem",
"type" : "Lorem",
"value" : "Lorem"
}, {
"action" : "Lorem",
"type" : "Lorem",
"value" : "Lorem"
} ]
}
2.9. Sync Assignments
2.9.1. Search action codes
POST |
/action-codes/search |
Description
Search action codes
DMF required:
-
DMF A70212: Api Mobile / Time Recordings / Search Assignments
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Or
-
DMF A70312: Api Mobile / Schedules / Search Assignments
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria MobActionCriteria |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
project_id |
Filter by a project id |
X |
null |
Return Type
array[MobAction]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Action Codes successfully loaded |
List[MobAction] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"code" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"name" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"validity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
}
}
2.9.2. Search Assignment
POST |
/assignments/{active_module}/search |
Description
Search Assignment
DMF required:
-
DMF A70212: Api Mobile / Time Recordings / Search Assignments
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Or
-
DMF A70312: Api Mobile / Schedules / Search Assignments
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
active_module |
The active module |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria AssignmentCriteria |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
limit |
The max number of ancestor nodes (ex if countAssignmentType = PROJECT then the number of projects will be limited to the 'limit' specified) |
- |
null |
Return Type
array[AssignmentNode]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Projects successfully loaded |
List[AssignmentNode] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"lowerAssignmentType" : "{}",
"projectSubcategorieLevel2Id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"scheduled" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"countAssignmentType" : "{}",
"projectClosed" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"departmentId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectOnLeave" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"projectProductionManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"yearId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"activityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectStateCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeePartitioning" : true,
"projectTaskEmployeeLinkedId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"customerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"phaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"divisionId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"upperAssignmentType" : "{}",
"subPhaseCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectCategorieId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2000-01-23T04:56:07.000+00:00",
"divisionGroupId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDateEnd" : "2000-01-23T04:56:07.000+00:00",
"projectInternal" : {
"operator" : "IS",
"value" : false,
"includeNullResults" : false
},
"employeeId" : "employeeId",
"entityId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"ignoreProjectAllCustomer" : true,
"employeeIdScheduled" : [ "employeeIdScheduled", "employeeIdScheduled" ],
"projectTaskId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"companyId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectGroupCode" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"subPhaseId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"allCompanies" : true,
"mainCustomer" : true,
"projectManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSalesManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tagIdScheduled" : [ "tagIdScheduled", "tagIdScheduled" ],
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectFinancialManagerId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectSubCategorieId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectEmployeeLinkedId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.9.3. Search Customers
POST |
/customers/search |
Description
Search Customers
DMF required:
-
DMF A70212: Api Mobile / Time Recordings / Search Assignments
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Or
-
DMF A70312: Api Mobile / Schedules / Search Assignments
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Search criteria MobCustomerCriteria |
- |
Return Type
array[AssignmentNode]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Customers successfully loaded |
List[AssignmentNode] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"filterOnLinkProjectCustomer" : true,
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"projectId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"referentialDate" : "2020-01-23T04:56:07Z"
}
2.10. Sync Custom Requests
2.10.1. Cancel completion of a custom request
POST |
/custom-requests/{custom_request_id}/cancel-completion |
Description
Cancel completion of a custom request asking approvals.
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Completion successfully canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.2. Cancel a custom request
POST |
/custom-requests/{custom_request_id}/cancel |
Description
Cancel a custom request
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom request successfully canceled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.3. Complete a custom request
POST |
/custom-requests/{custom_request_id}/complete |
Description
Complete a custom request asking approvals.
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom request successfully completed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.4. Create a Custom Request
PUT |
/custom-request |
Description
Create a Custom Request
DMF required:
-
DMF A70801: Api Mobile / Custom Requests / Insert
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequest |
The Custom Request to create MobCustomRequest |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"number" : "CC00001",
"date" : "2020-01-31T23:59:59Z",
"name" : "Label for my doc",
"description" : "Lorem ipsum",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"lines" : [ {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
}, {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2020-01-31T23:59:59Z",
"icon" : "fas fa-pen",
"companyId" : "5000130",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : false,
"defaultValueWithoutExpense" : false,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"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" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"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" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000130",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUserId" : "5000130",
"approvalState" : "{}",
"approvalDate" : "2020-01-31T23:59:59Z",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
}
}
2.10.5. Create a custom request line
PUT |
/custom-requests/{custom_request_id}/custom-request-lines |
Description
Create a custom request line
DMF required:
-
DMF A70801: Api Mobile / Custom Requests / Insert
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestLine |
The custom request line to create MobCustomRequestLine |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The custom request line has been successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
}
2.10.6. Delete a Custom Request
DELETE |
/custom-requests/{custom_request_id} |
Description
Delete a Custom Request
DMF required:
-
DMF A70803: Api Mobile / Custom Requests / Delete
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Custom Request successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.7. Delete a custom request line
DELETE |
/custom-requests/{custom_request_id}/custom-request-lines/{custom_request_line_id} |
Description
Delete a custom request line
DMF required:
-
DMF A70803: Api Mobile / Custom Requests / Delete
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
|
custom_request_line_id |
Id of a custom request line |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
The custom request line has been successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.8. Generate expenses from a custom request
POST |
/custom-requests/{custom_request_id}/generate-expenses |
Description
Generate expenses from a custom request
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expenses successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.9. Get a Custom Request
GET |
/custom-requests/{custom_request_id} |
Description
Get a Custom Request
DMF required:
-
DMF A70806: Api Mobile / Custom Requests / Info
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.10. Pre-fill a Custom Request
POST |
/custom-request-categories/{custom_request_category_id}/custom-requests/pre-fill |
Description
Pre-fill a Custom Request
DMF required:
-
DMF A70801: Api Mobile / Custom Requests / Insert
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
object_type |
The type of object (see SchedulePreFillObjectType or TimesheetPreFillObjectType) |
- |
null |
|
object_id |
The id of the object used to fill in the schedule or the timesheet or … |
- |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request successfully pre-filled |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.11. Search for custom request cities
POST |
/custom-requests/custom-request-categories/{custom_request_category_id}/cities/find |
Description
Get a list of the departure or arrival cities matching the parameters in MobCustomRequestLocationParamHolder.
DMF required:
-
DMF A70806: Api Mobile / Custom Requests / Info
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_category_id |
Id of a custom request's category |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
MobCustomRequestLocationParamHolder |
Parameters that you choose (search text, type, etc.). The parameter 'type' indicates whether you are searching for arrival cities or departure cities. MobCustomRequestLocationParamHolder |
- |
Return Type
array[City]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Cities successfully loaded |
List[City] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"searchText" : "searchText",
"customerIds" : [ "customerIds", "customerIds" ]
}
2.10.12. Get my custom requests
GET |
/custom-requests/mine |
Description
Search my custom requests
DMF required:
-
DMF A70804: Api Mobile / Custom Requests / Search
-
DMF 5007__: Mobile * * / Internal Requests
Return Type
array[MobCustomRequest]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Requests successfully loaded |
List[MobCustomRequest] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.10.13. Update a Custom Request
POST |
/custom-requests/{custom_request_id} |
Description
Update a Custom Request
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequest |
The Custom Request to update MobCustomRequest |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Custom Request successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"number" : "CC00001",
"date" : "2020-01-31T23:59:59Z",
"name" : "Label for my doc",
"description" : "Lorem ipsum",
"afterTaxAmount" : 120.37,
"preTaxAmount" : 100.14,
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"lines" : [ {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
}, {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
} ],
"category" : {
"id" : "50000012",
"code" : "CATEGORY_1",
"name" : "Category one",
"endDate" : "2020-01-31T23:59:59Z",
"icon" : "fas fa-pen",
"companyId" : "5000130",
"enableActualDates" : true,
"enableEndDate" : true,
"editableWithoutExpense" : false,
"defaultValueWithoutExpense" : false,
"scheduleCreation" : true,
"timesheetCreation" : true,
"departureLocation" : true,
"departureLocationType" : "{}",
"destinationLocation" : true,
"destinationLocationType" : "{}",
"displayCustomData" : true,
"customDataStart" : 1,
"customDataEnd" : 9,
"customDataNbColumns" : 2
},
"categoryId" : "5000123",
"employeeId" : "5000123",
"departureDate" : "2020-01-31T23:59:59Z",
"departureActualDate" : "2020-01-31T23:59:59Z",
"departureCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"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" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"departureLocation" : "Lyon",
"arrivalDate" : "2020-01-31T23:59:59Z",
"arrivalActualDate" : "2020-01-31T23:59:59Z",
"arrivalCity" : {
"id" : "5000123",
"name" : "City 1",
"default" : true,
"postcode" : "73000",
"country" : {
"id" : "5000123",
"name" : "Country 1",
"currency" : {
"id" : "5000123",
"name" : "Euro",
"code" : "EUR",
"order" : 17,
"euro" : true,
"euroRate" : 0.9678,
"endDate" : "2000-06-21T04:56:07.000+00:00",
"euroRateStartDate" : "2020-01-23T04:56:07Z",
"euroRateEndDate" : "2020-01-23T04:56:07Z"
},
"currencyId" : "5000123",
"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" : "5000123",
"code" : "FR",
"companyCode" : "AKSAS",
"companyId" : "5000123",
"isPartOfEU" : true,
"continent" : "AFRICA"
},
"countryId" : "5000123",
"department" : {
"id" : "5000123",
"code" : "01-A",
"companyCode" : "AKSAS",
"name" : "Lorem Ipsum",
"analysis" : "analysis",
"comment" : "comment",
"entity" : {
"id" : "5000123",
"code" : "01-BRDX",
"name" : "Bordeaux",
"legalName" : "Customer care",
"division" : {
"id" : "5000123",
"name" : "Rhone-Alpes",
"code" : "RA",
"group" : {
"id" : "5000123",
"name" : "West",
"code" : "WST",
"serviceId" : "5000123"
},
"groupId" : "5000123",
"companyId" : "5000123"
},
"divisionId" : "5000123",
"divisionCode" : "01-DIV",
"companyId" : "5000123",
"endDate" : "2020-01-23T04:56:07Z"
},
"entityId" : "entityId",
"projectType" : "{}",
"activities" : [ {
"id" : "5000123",
"code" : "code",
"name" : "name"
}, {
"id" : "5000123",
"code" : "code",
"name" : "name"
} ]
},
"departmentId" : "5000123",
"regionId" : "123456",
"companyCode" : "AKSAS",
"latitude" : "5.9845W",
"longitude" : "37.3891N"
},
"arrivalLocation" : "Oslo",
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"numberOfDocuments" : 2,
"formConfig" : {
"type" : "{}",
"fields" : [ {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}, {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
} ],
"controls" : {
"key" : {
"id" : "50000123",
"property" : "Kilometers",
"required" : true,
"visible" : true,
"enabled" : true,
"defaultValue" : "50 (for the field 'Kilometers' case)",
"valueSelectors" : [ "valueSelectors", "valueSelectors" ],
"additionalValueSelectors" : [ "additionalValueSelectors", "additionalValueSelectors" ],
"freeValue" : true,
"allowMultipleValues" : true,
"information" : "Lorem ipsum"
}
},
"insertable" : true,
"editable" : false,
"deletable" : false,
"formSearchHidden" : false
},
"cancellationDate" : "2020-01-31T23:59:59Z",
"cancellationUser" : {
"id" : "5000123",
"code" : "TRI",
"name" : "Doe",
"firstName" : "John"
},
"cancellationUserId" : "5000130",
"archiveDate" : "2020-01-31T23:59:59Z",
"archiveUserId" : "5000130",
"approvalState" : "{}",
"approvalDate" : "2020-01-31T23:59:59Z",
"customData" : {
"key" : {
"type" : "{}",
"value" : "Autoref 010520",
"name" : "Reference 4",
"realOrder" : 0,
"label" : "REFERENCE_4"
}
}
}
2.10.14. Update a custom request line
POST |
/custom-requests/{custom_request_id}/custom-request-lines/{custom_request_line_id} |
Description
Update a custom request line
DMF required:
-
DMF A70802: Api Mobile / Custom Requests / Update
-
DMF 5007__: Mobile * * / Internal Requests
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
custom_request_id |
The id of a custom request |
X |
null |
|
custom_request_line_id |
Id of a custom request line |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customRequestLine |
The custom request line to update MobCustomRequestLine |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The custom request line has been successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"id" : "5000123",
"name" : "Helpdesk",
"expenseTypeExpected" : {
"id" : "5000123",
"code" : "AIR-PL",
"name" : "Airplane",
"description" : "Transportation",
"endDate" : "2020-01-31T23:59:59Z",
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"editableExpenseReport" : true,
"defaultExpenseReport" : true
},
"expenseTypeExpectedId" : "5000123",
"isExpenseReport" : true,
"rankNumber" : 2,
"quantity" : 3,
"unitPriceCurrency" : 36.32,
"unitPrice" : 40,
"amountTotalCurrency" : 1200,
"amountTotal" : 1200
}
2.11. Sync Documents
2.11.1. Download document
GET |
/documents/{document_id}/download |
Description
Download document
DMF required:
-
DMF A70506: Api Mobile / Documents / Info
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document_id |
The id of the document |
X |
null |
Content Type
-
application/octet-stream
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.2. Get an image preview of a document by its id
GET |
/documents/{document_id}/preview-image |
Description
Get an image preview of a document by its id
DMF required:
-
DMF A70506: Api Mobile / Documents / Info
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document_id |
The id of the document |
X |
null |
Content Type
-
image/*
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The image preview document |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.11.3. Upload a document
POST |
/documents/upload |
Description
Upload a document in a temporary directory
DMF required:
-
DMF A70510: Api Mobile / Documents / Upload
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Form Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
document |
The file to upload. [file] |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The document has succefully been uploaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12. Sync Expense Reports
2.12.1. Calculate kilometers compensation
POST |
/expenses/calculate-amounts-kilometers-compensation |
Description
Calculate total of kilometers driven and amounts for kilometers compensation for a given employee in the current year.
DMF required:
-
DMF A41210: Api Workforce / Vehicle / Calculate Amounts For Kilometers Compensation
-
DMF 190505: Web Portal / Expense Reports / Complete Expense Report
-
DMF 160852: Tools / Resources / Show Taxable Powers
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
mobExpenseWithVehicleParamHolder |
The context of the expense. MobExpenseWithVehicleParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successfully calculated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"licensePlate" : "AA-123-BB",
"kilometersEnteredOnCurrentExpense" : 512,
"expenseId" : "5000123",
"employeeId" : "5000869",
"expenseTypeId" : "5000478",
"power" : 5,
"completed" : true,
"expenseReportId" : 5000728,
"expenseDate" : "2020-01-31T23:59:59Z"
}
2.12.2. Cancel an expense report completion
POST |
/expense-reports/{expense_report_id}/cancel-completion |
Description
Cancel an expense report completion
DMF required:
-
DMF A70411: Api Mobile / Expenses / Cancel Completion
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report completion successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.3. Cancel a smart scan
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/cancel-smart-scan |
Description
Cancel a smart scan
DMF required:
-
DMF A70413: Api Mobile / Expenses / Cancel Smartscan
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
The id of an expense |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Smart scan successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.4. Check the mileage scale
GET |
/expense-reports/{expense_report_id}/check-mileage-scale |
Description
Check if the mileage scale will change if the expense report is completed.
DMF required:
-
DMF A70414: Api Mobile / Expenses / Check Mileage Scale
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Mileage scale successfully checked. |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.5. Complete an expense report
POST |
/expense-reports/{expense_report_id}/complete |
Description
Complete an expense report
DMF required:
-
DMF A70410: Api Mobile / Expenses / Complete
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense report successfully completed |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.6. Create an expense
PUT |
/expense-reports/expenses |
Description
Create an expense
DMF required:
-
DMF A70401: Api Mobile / Expenses / Insert
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense |
The expense to create MobLigneNdf |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"identExpReport" : 1,
"expenseDate" : "2020-01-23T04:56:07Z",
"datCre" : "2020-01-23T04:56:07Z",
"amount" : 1,
"amountCurrency" : 1,
"title" : "Lorem ipsum",
"complementName" : "Lorem ipsum",
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"validated" : true,
"finished" : true,
"hasDocuments" : true,
"vat1" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vatAmount1" : 1,
"vatAmount2" : 1,
"vatAmount3" : 1,
"type" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"engineTaxRate" : {
"ident" : 1,
"power" : 1,
"price" : 1,
"expenseTypeId" : 1,
"expenceTypeCode" : "ABC",
"code" : "ABC",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z"
},
"rebillable" : true,
"notRefundable" : true,
"receiptNb" : "123",
"kilometer" : 1,
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"guests" : [ {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
}, {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
} ],
"businessCard" : true,
"dateOfDenial" : "2020-01-23T04:56:07Z",
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"quantity" : 1,
"parts" : 2,
"amountCategory" : "{}",
"unitPrice" : 1,
"unitPriceCurrency" : 1,
"afterTaxAmountRefunded" : 1,
"afterTaxCurrencyAmountRefunded" : 1,
"smartScan" : true,
"amountWithoutVat" : 1,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "ABC123",
"employee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"endDate" : "2020-01-23T04:56:07Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"isDuplicateExpenseForSameEmployee" : true,
"isDuplicateExpenseForSeveralEmployee" : true,
"isExpenseOnEmployeeNonWorkingDay" : true,
"isExpenseOnEmployeeLeaveDay" : true
}
2.12.7. Delete an expense
DELETE |
/expense-reports/{expense_report_id}/expenses/{expense_id} |
Description
Delete an expense
DMF required:
-
DMF A70403: Api Mobile / Expenses / Delete
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
The id of an expense |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Expense successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.8. Get distance between two places
POST |
/google/get-distance |
Description
Get distance between two places
DMF required:
-
ADMINW: Server administration console user.
Or
-
DMF AH0302: Api Service Integration / Google / Get Distance
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
addresses |
Get distance between two places via Google API MobDistanceParameters |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Distance successfully calculated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"originId" : "ChIJj8SBJfnq9EcRyFlMQzPxAnU",
"origin" : "Lorem ipsum",
"destination" : "Lorem ipsum",
"avoidHighways" : true,
"avoidTolls" : true,
"destinationId" : "ChIJj8SBJfnq9EcRyFlMQzPxAnU"
}
2.12.9. Get an expense
GET |
/expense-reports/{expense_report_id}/expenses/{expense_id} |
Description
Get an expense
DMF required:
-
DMF A70406: Api Mobile / Expenses / Info
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
The id of an expense |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.10. Move an expense
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id}/move |
Description
Move an expense to an existing expense report or to a new one
DMF required:
-
DMF A70412: Api Mobile / Expenses / Move Expense
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
The id of an expense |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
new_expense_report_id |
The target expense report |
- |
null |
|
expense_date |
The expense date |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully moved |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.11. Search Google places
POST |
/google/places |
Description
Search Google places
DMF required:
-
DMF AH0301: Api Service Integration / Google / Search Places
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
searchText |
Search places via Google API (use the value field in the StringParamHolder resource) StringParamHolder |
X |
Return Type
array[MobPlaceSearchResult]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Places successfully found |
List[MobPlaceSearchResult] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"value" : "true"
}
2.12.12. Get my expense reports
GET |
/expense-reports/mine |
Description
Search my expense reports
DMF required:
-
DMF A70404: Api Mobile / Expenses / Search
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Return Type
array[MobNdf]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense Reports successfully loaded |
List[MobNdf] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.12.13. Search for vehicles (with search criteria)
POST |
/vehicles/search |
Description
Get the list of vehicles matching the search criteria, with a history in the corresponding time slot.
DMF required:
-
DMF A41204: Api Workforce / Vehicle / Search
-
DMF 190502: Web Portal / Expense Reports / Modify
-
DMF 160852: Tools / Resources / Show Taxable Powers
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
Criteria that you choose (Employee ID, Expense type ID, etc…) MobVehicleCriteria |
X |
Return Type
array[MobVehicle]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees successfully loaded |
List[MobVehicle] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"licensePlate" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"employeeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"expenseTypeId" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
},
"power" : {
"operator" : "IS",
"value" : 12.6,
"includeNullResults" : false
},
"validity" : {
"date" : "2000-01-23T04:56:07.000+00:00"
}
}
2.12.14. Update an expense
POST |
/expense-reports/{expense_report_id}/expenses/{expense_id} |
Description
Update an expense
DMF required:
-
DMF A70402: Api Mobile / Expenses / Update
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense_report_id |
Id of an expense report |
X |
null |
|
expense_id |
The id of an expense |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
expense |
The expense to update MobLigneNdf |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Expense successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"identExpReport" : 1,
"expenseDate" : "2020-01-23T04:56:07Z",
"datCre" : "2020-01-23T04:56:07Z",
"amount" : 1,
"amountCurrency" : 1,
"title" : "Lorem ipsum",
"complementName" : "Lorem ipsum",
"currency" : {
"ident" : 1,
"code" : "ABC",
"euro" : true,
"euroRate" : 1,
"endDate" : "2020-01-23T04:56:07Z",
"order" : 1
},
"validated" : true,
"finished" : true,
"hasDocuments" : true,
"vat1" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vatAmount1" : 1,
"vatAmount2" : 1,
"vatAmount3" : 1,
"type" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"engineTaxRate" : {
"ident" : 1,
"power" : 1,
"price" : 1,
"expenseTypeId" : 1,
"expenceTypeCode" : "ABC",
"code" : "ABC",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z"
},
"rebillable" : true,
"notRefundable" : true,
"receiptNb" : "123",
"kilometer" : 1,
"documents" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"documentsToDelete" : [ {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
}, {
"ident" : 1,
"identVersion" : 1,
"createDate" : "2020-01-23T04:56:07Z",
"fileUrl" : "https://example.com/document.pdf",
"sysName" : "document.pdf",
"title" : "Lorem ipsum",
"internal_ident" : "5000130",
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"version" : 1,
"deleted" : true,
"token" : "5e93a341-8664-44c5-8794-a4b4f9577142"
} ],
"guests" : [ {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
}, {
"ident" : 1,
"lastName" : "Doe",
"firstName" : "John",
"identEmployee" : 1,
"codeEmployee" : "ABC",
"company" : "Akuiteo"
} ],
"businessCard" : true,
"dateOfDenial" : "2020-01-23T04:56:07Z",
"refusalComment" : "Lorem ipsum",
"refusingEmployee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"quantity" : 1,
"parts" : 2,
"amountCategory" : "{}",
"unitPrice" : 1,
"unitPriceCurrency" : 1,
"afterTaxAmountRefunded" : 1,
"afterTaxCurrencyAmountRefunded" : 1,
"smartScan" : true,
"amountWithoutVat" : 1,
"vehicle" : {
"id" : "5000123",
"power" : 5,
"licensePlate" : "ABC123",
"employee" : {
"ident" : 1,
"code" : "ABC",
"lastName" : "Doe",
"firstName" : "John",
"company" : "ABC"
},
"expenseType" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"type" : "Lorem",
"canUseInvitation" : true,
"canUseNotRefundable" : true,
"canUseKm" : true,
"canUseQuantity" : true,
"canUseDoubleVAT" : true,
"canUseAdditionalComment" : true,
"canEditCurrencyVATIncl" : true,
"canUseReceiptNumber" : true,
"limit" : 1,
"hideVat" : true,
"vat" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat2" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"vat3" : {
"ident" : 1,
"code" : "ABC",
"description" : "Lorem ipsum",
"rate" : 1,
"key" : "ABC"
},
"amountDft" : 1,
"icon" : "fa fa-icon",
"color" : "#00eeff",
"receiptRequired" : true,
"commentRequired" : true,
"amountEditable" : true,
"billableEditable" : true,
"notRefundableEditable" : true,
"expenseCategory" : "{}",
"controlsBehavior" : [ {
"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"
} ],
"canUseAmountWithoutVat" : true,
"expenseThresholdExceededNoVat" : false,
"endDate" : "2020-01-23T04:56:07Z"
},
"endDate" : "2020-01-23T04:56:07Z"
},
"kmTotal" : 50,
"amountCalculated" : 35,
"amountRefunded" : 700,
"amountDue" : 35,
"departureLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"arrivalLocation" : "27 Rue Auguste Comte, 69002 Lyon, France",
"isDuplicateExpenseForSameEmployee" : true,
"isDuplicateExpenseForSeveralEmployee" : true,
"isExpenseOnEmployeeNonWorkingDay" : true,
"isExpenseOnEmployeeLeaveDay" : true
}
2.13. Sync Leaves
2.13.1. Send mail to cancel validation
POST |
/leaves/{leave_id}/ask-for-cancelation |
Description
Send mail to cancel validation
DMF required:
-
DMF A70110: Api Mobile / Leaves / Ask For Cancelation
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of a Leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
message |
The message to send [string] |
- |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Cancelation successfully asked |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
message_example
2.13.2. Cancel a Leave
DELETE |
/leaves/{leave_id}/cancel |
Description
Cancel a Leave
DMF required:
-
DMF A70103: Api Mobile / Leaves / Delete
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of a Leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Leave successfully cancelled |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.3. Create a leave
PUT |
/leaves |
Description
Create a leave
DMF required:
-
DMF A70101: Api Mobile / Leaves / Insert
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave |
The leave to create MobLeave |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"id" : "5000130",
"leaveRightId" : "5000130",
"requestDate" : "2020-01-23T04:56:07Z",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"duration" : 1,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"startAfterNoon" : true,
"commentValidator" : "Lorem ipsum",
"dateValidator" : "2020-01-23T04:56:07Z",
"employeeValidator" : "Lorem"
}
2.13.4. Delete a Leave
DELETE |
/leaves/{leave_id} |
Description
Delete a Leave
DMF required:
-
DMF A70103: Api Mobile / Leaves / Delete
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of a Leave |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Leave successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.5. Estimate the leave rights at a specific date
POST |
/leaves/rights/{leave_right_id}/estimate |
Description
Estimate the leave rights at a specific date.
DMF required:
-
DMF A70104: Api Mobile / Leaves / Search
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_right_id |
The leave right id |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
date |
The date |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
The value of the remaining right at the specified date |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.6. Fill in duration properties in the leave
POST |
/leaves/rights/{leave_right_id}/fill-duration |
Description
Fill in duration properties in the leave (end of leave OR duration) according to the leave right and other properties (start of leave / end of leave OR duration) and returns the completed leave without saving it.
DMF required:
-
DMF A70102: Api Mobile / Leaves / Update
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_right_id |
The leave right id |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
properties |
The duration properties to be filled in MobLeaveDuration |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave's duration filled in |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"duration" : 20.5,
"estimatedRightAtStart" : 12,
"startAfterNoon" : true,
"start" : "2020-01-23T04:56:07Z",
"end" : "2020-01-23T04:56:07Z"
}
2.13.7. Get a Leave
GET |
/leaves/{leave_id} |
Description
Get a Leave
DMF required:
-
DMF A70106: Api Mobile / Leaves / Info
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of a Leave |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.8. Get my leaves' rights
GET |
/leaves/rights/mine |
Description
Get my leaves' rights
DMF required:
-
DMF A70104: Api Mobile / Leaves / Search
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Return Type
array[MobLeaveRight]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves retrieved successfully |
List[MobLeaveRight] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.9. Get my leaves
GET |
/leaves/mine |
Description
Search my leaves
DMF required:
-
DMF A70104: Api Mobile / Leaves / Search
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Return Type
array[MobLeave]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leaves successfully loaded |
List[MobLeave] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.13.10. Update a Leave
POST |
/leaves/{leave_id} |
Description
Update a Leave
DMF required:
-
DMF A70102: Api Mobile / Leaves / Update
-
DMF 5004__: Mobile * * / Mobile Leave Requests *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave_id |
The id of a Leave |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
leave |
The Leave to update MobLeave |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Leave successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"id" : "5000130",
"leaveRightId" : "5000130",
"requestDate" : "2020-01-23T04:56:07Z",
"startDate" : "2020-01-23T04:56:07Z",
"endDate" : "2020-01-23T04:56:07Z",
"duration" : 1,
"comment" : "Lorem ipsum",
"leaveState" : "{}",
"startAfterNoon" : true,
"commentValidator" : "Lorem ipsum",
"dateValidator" : "2020-01-23T04:56:07Z",
"employeeValidator" : "Lorem"
}
2.14. Sync Remote Work Entries
2.14.1. Create a remote work entry
PUT |
/remote-work-entries |
Description
Create a remote work entry
DMF required:
-
DMF A70701: Api Mobile / Remote Work Entries / Insert
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timeRecording |
The remote work entry to create MobRemoteWorkEntry |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remote work entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"afternoon" : true,
"id" : "5000130",
"morning" : true
}
2.14.2. Declare a recurring remote work for a period
POST |
/remote-work-entries/declare-recurring |
Description
Declare a recurring remote work for a period
DMF required:
-
DMF A70710: Api Mobile / Remote Work Entries / Declare Recurring
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
recurringRemoteWork |
The recurring remote work declaration MobRecurringRemoteWork |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful declaration of recurring remote work |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"sunday" : {
"afternoon" : true,
"morning" : false
},
"saturday" : {
"afternoon" : true,
"morning" : false
},
"tuesday" : {
"afternoon" : true,
"morning" : false
},
"endDate" : "2020-01-31T23:59:59Z",
"wednesday" : {
"afternoon" : true,
"morning" : false
},
"thursday" : {
"afternoon" : true,
"morning" : false
},
"friday" : {
"afternoon" : true,
"morning" : false
},
"startDate" : "2020-01-31T23:59:59Z",
"monday" : {
"afternoon" : true,
"morning" : false
}
}
2.14.3. Delete a remote work entry
DELETE |
/remote-work-entries/{remote_work_entry_id} |
Description
Delete a remote work entry
DMF required:
-
DMF A70703: Api Mobile / Remote Work Entries / Delete
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
remote_work_entry_id |
The id of a remote work entry |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Remote work entry successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.4. Get a remote work entry
GET |
/remote-work-entries/{remote_work_entry_id} |
Description
Get a remote work entry
DMF required:
-
DMF A70706: Api Mobile / Remote Work Entries / Info
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
remote_work_entry_id |
The id of a remote work entry |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remote work entry successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.5. Get my remote work entries
GET |
/remote-work-entries/mine |
Description
Search my remote work entries
DMF required:
-
DMF A70704: Api Mobile / Remote Work Entries / Search
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Return Type
array[MobRemoteWorkEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remote work entries successfully loaded |
List[MobRemoteWorkEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.14.6. Update a remote work entry
POST |
/remote-work-entries/{remote_work_entry_id} |
Description
Update a remote work entry
DMF required:
-
DMF A70702: Api Mobile / Remote Work Entries / Update
-
DMF 5006__: Mobile * * / Mobile Remote Work *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
remote_work_entry_id |
The id of a remote work entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timeRecording |
The remote work entry recording to update MobRemoteWorkEntry |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Remote work entry successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"afternoon" : true,
"id" : "5000130",
"morning" : true
}
2.15. Sync Schedules
2.15.1. Create a schedule
PUT |
/schedules |
Description
Create a schedule
DMF required:
-
DMF A70301: Api Mobile / Schedules / Insert
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule |
The schedule to create MobSchedule |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully created |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"planningAction" : "{}",
"descriptive" : "Lorem ipsum",
"validated" : true,
"leave" : true,
"siteId" : "5000130",
"onlineMeeting" : false,
"endDate" : "2020-01-23T04:56:07Z",
"dayPart" : 1,
"dayMode" : true,
"color" : "#ff0000"
}
2.15.2. Delete a Schedule
DELETE |
/schedules/{schedule_id} |
Description
Delete a Schedule
DMF required:
-
DMF A70303: Api Mobile / Schedules / Delete
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of a schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.3. Fill in a schedule
POST |
/schedules/fill |
Description
Fill in a schedule to update several fields. Options to fill in the schedule are listed in the link below.
DMF required:
-
DMF A40401: Api Workforce / Schedules / Insert
-
DMF 060201: Projects / Schedules / New
-
DMF 190402: Web Portal / Schedules / Modify
-
DMF 250102: Project / Schedule View / New
-
DMF 250104: Project / Schedule View / Dissociate Scheduled Item
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
scheduleFillParamHolder |
The schedule to be filled in MobScheduleFillParamHolder |
X |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully filled in |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"schedule" : {
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"planningAction" : "{}",
"descriptive" : "Lorem ipsum",
"validated" : true,
"leave" : true,
"siteId" : "5000130",
"onlineMeeting" : false,
"endDate" : "2020-01-23T04:56:07Z",
"dayPart" : 1,
"dayMode" : true,
"color" : "#ff0000"
},
"options" : { }
}
2.15.4. Get default schedule locations
GET |
/schedules/locations/default |
Description
Get default schedule locations
DMF required:
-
DMF A70311: Api Mobile / Schedules / Search Places
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
The id of the client |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful default schedule location |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.5. Get a Schedule
GET |
/schedules/{schedule_id} |
Description
Get a Schedule
DMF required:
-
DMF A70306: Api Mobile / Schedules / Info
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of a schedule |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.6. Get my schedules
GET |
/schedules/mine |
Description
Search my schedules
DMF required:
-
DMF A70304: Api Mobile / Schedules / Search
-
DMF 5003__: Mobile * * / Mobile Schedules *
Return Type
array[MobSchedule]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully loaded |
List[MobSchedule] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.7. Search schedule locations
GET |
/schedules/locations/search |
Description
Search schedule locations
DMF required:
-
DMF A70311: Api Mobile / Schedules / Search Places
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
The id of the client |
X |
null |
|
tag |
Tag to filter |
- |
null |
Return Type
array[MobEventLocation]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful schedule locations search |
List[MobEventLocation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.8. Get the list of Schedules
POST |
/schedules/search |
Description
Search Schedules
DMF required:
-
DMF A70304: Api Mobile / Schedules / Search
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria MobScheduleCriteria |
X |
Return Type
array[MobSchedule]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedules successfully loaded |
List[MobSchedule] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"id" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.15.9. Transfer a Schedule into timesheets
GET |
/schedules/{schedule_id}/transfer-in-timesheets |
Description
Transfer a Schedule into timesheets
DMF required:
-
DMF A40417: Api Workforce / Schedules / Transfer My Timesheet Entry
-
DMF 190406: Web Portal / Schedules / Transfer Timesheets
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of a schedule |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Schedule successfully transferred |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.15.10. Update a Schedule
POST |
/schedules/{schedule_id} |
Description
Update a Schedule
DMF required:
-
DMF A70302: Api Mobile / Schedules / Update
-
DMF 5003__: Mobile * * / Mobile Schedules *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule_id |
The id of a schedule |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
schedule |
The Schedule to update MobSchedule |
- |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Schedule successfully updated |
List[[string]] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"planningAction" : "{}",
"descriptive" : "Lorem ipsum",
"validated" : true,
"leave" : true,
"siteId" : "5000130",
"onlineMeeting" : false,
"endDate" : "2020-01-23T04:56:07Z",
"dayPart" : 1,
"dayMode" : true,
"color" : "#ff0000"
}
2.16. Sync Setup
2.16.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
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customizable_resource |
The type of customizable resource |
X |
null |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customizable_resource_id |
The id of customizable resource |
- |
null |
Return Type
array[CustomDataParam]
Content Type
-
application/json
Responses
| 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. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.16.2. Get all values of a keyword
GET |
/keywords/{keyword_id}/values |
Description
Get all values of a keyword
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
keyword_id |
The keyword id |
X |
null |
Return Type
array[MobKeywordValue]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
List of values of a keyword |
List[MobKeywordValue] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.16.3. Get translations for mobile
GET |
/translations/{locale} |
Description
Get translations for mobile
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
locale |
The requested locale |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Translations successfully loaded |
|
404 |
Requested resource could not be found |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.16.4. Search employees
POST |
/employees/search |
Description
Search employees
DMF required:
-
DMF A70402: Api Mobile / Expenses / Update
-
DMF 5001__: Mobile * * / Mobile Expense Reports *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
criteria |
The criteria MobCollaborateurCriteria |
X |
Return Type
array[MobCollaborateur]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Employees available |
List[MobCollaborateur] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"tag" : {
"operator" : "IS",
"value" : "Abcd",
"includeNullResults" : false,
"wildcards" : "*"
}
}
2.17. Sync Timesheet Quick Entries
2.17.1. Create a Quick Entry from a Timesheet entry
PUT |
/timesheet-entries/{timesheet_entry_id}/quick-entries |
Description
Create a Quick Entry from a Timesheet entry
DMF required:
-
DMF A70601: Api Mobile / Time Recording Quick Entries / Insert
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of a timesheet entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
label |
The label for the Quick Entry [string] |
- |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry Quick Entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
label_example
2.17.2. Delete a Timesheet entry Quick Entry
DELETE |
/timesheet-entries/quick-entries/{timesheet_quick_entry_id} |
Description
Delete a Timesheet entry Quick Entry
DMF required:
-
DMF A70603: Api Mobile / Time Recording Quick Entries / Delete
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_quick_entry_id |
The id of a timesheet entry quick entry |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Timesheet entry Quick Entry successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.17.3. Search My Quick Entries Time
GET |
/timesheet-entries/quick-entries/mine |
Description
Search My Quick Entries Time
DMF required:
-
DMF A70604: Api Mobile / Time Recording Quick Entries / Search
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Return Type
array[MobActiviteParDefaut]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My Quick Entries Time |
List[MobActiviteParDefaut] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18. Sync Timesheets
2.18.1. Add a completion
POST |
/timesheet-entries/completion/add |
Description
Add a completion. Depending on the management rule TPS_TERMINAISON, the completion is on a month or on a week
DMF required:
-
DMF A70213: Api Mobile / Time Recordings / Termination
-
DMF 5002__: Mobile * * / Mobile Timesheets *
-
DMF 500201: Mobile * * / Mobile Timesheets * / Mobile Timesheets Cancel Completion
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
completion |
The TimesheetEntryCompletion MobTimesheetEntryCompletion |
X |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Return id of the completion entry. |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"id" : "5000130",
"completionType" : "WEEK"
}
2.18.2. Create a timesheet entry
PUT |
/timesheet-entries |
Description
Create a timesheet entry. Error with code 'WARNING' can be returned, which can be ignored with ignore_warning parameter.
DMF required:
-
DMF A70201: Api Mobile / Time Recordings / Insert
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timeRecording |
The timesheet entry to create MobTimesheetEntry |
X |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ignore_warning |
If true, the request will ignore warning messages. Default value is false. |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry successfully created |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"action2" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem"
},
"completionDate" : "2020-01-23T04:56:07Z"
}
2.18.3. Delete a timesheet entry
DELETE |
/timesheet-entries/{timesheet_entry_id} |
Description
Delete a timesheet entry
DMF required:
-
DMF A70203: Api Mobile / Time Recordings / Delete
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of a timesheet entry |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Timesheet entry successfully deleted |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.4. Get Default Timesheet entry location
GET |
/timesheet-entries/locations/default |
Description
Get Default Timesheet entry location
DMF required:
-
DMF A70211: Api Mobile / Time Recordings / Search Places
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
The id of the client |
X |
null |
|
project_task_id |
The id of the project task |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful default Timesheet entry location |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.5. Get my completions
GET |
/timesheet-entries/completion |
Description
Get my completions
DMF required:
-
DMF A70213: Api Mobile / Time Recordings / Termination
-
DMF 5002__: Mobile * * / Mobile Timesheets *
-
DMF 500201: Mobile * * / Mobile Timesheets * / Mobile Timesheets Cancel Completion
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Completions successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.6. Get a timesheet entry
GET |
/timesheet-entries/{timesheet_entry_id} |
Description
Get a timesheet entry
DMF required:
-
DMF A70206: Api Mobile / Time Recordings / Info
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of a timesheet entry |
X |
null |
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry successfully loaded |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.7. Remove a completion
POST |
/timesheet-entries/completion/remove |
Description
Remove a completion. Depending on the management rule TPS_TERMINAISON, the completion is on a month or on a week
DMF required:
-
DMF A70213: Api Mobile / Time Recordings / Termination
-
DMF 5002__: Mobile * * / Mobile Timesheets *
-
DMF 500201: Mobile * * / Mobile Timesheets * / Mobile Timesheets Cancel Completion
Parameters
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
completion |
The TimesheetEntryCompletion MobTimesheetEntryCompletion |
X |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Successful operation |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"date" : "2020-01-23T04:56:07Z",
"id" : "5000130",
"completionType" : "WEEK"
}
2.18.8. Get my timesheet entries
GET |
/timesheet-entries/mine |
Description
Search my timesheet entries
DMF required:
-
DMF A70204: Api Mobile / Time Recordings / Search
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
from |
From this date |
- |
null |
|
to |
To this date |
- |
null |
Return Type
array[MobTimesheetEntry]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entries successfully loaded |
List[MobTimesheetEntry] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.9. Search Timesheet entry locations
GET |
/timesheet-entries/locations/search |
Description
Search Timesheet entry locations
DMF required:
-
DMF A70211: Api Mobile / Time Recordings / Search Places
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
customer_id |
The id of the client |
X |
null |
|
tag |
Tag to filter |
- |
null |
Return Type
array[MobEventLocation]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Successful Timesheet entry locations search |
List[MobEventLocation] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.18.10. Update a timesheet entry
POST |
/timesheet-entries/{timesheet_entry_id} |
Description
Update a timesheet entry. Error with code 'WARNING' can be returned, which can be ignored with ignore_warning parameter.
DMF required:
-
DMF A70202: Api Mobile / Time Recordings / Update
-
DMF 5002__: Mobile * * / Mobile Timesheets *
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timesheet_entry_id |
The id of a timesheet entry |
X |
null |
Body Parameter
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
timeRecording |
The timesheet entry to update MobTimesheetEntry |
- |
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ignore_warning |
If true, the request will ignore warning messages. Default value is false. |
- |
null |
Content Type
-
text/plain
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Timesheet entry successfully updated |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
Samples
Body parameter
Click to expand
{
"guid" : "6B29FC40-CA47-1067-B31D-00DD010662DA",
"updateDate" : "2000-06-21T04:56:07.000+00:00",
"mobileUpdateDate" : "2000-06-21T04:56:07.000+00:00",
"errors" : {
"errors" : [ "errors", "errors" ]
},
"state" : "{}",
"customerId" : 1,
"projectId" : "PRJ_1",
"phaseId" : 5000123,
"subPhaseId" : 5000123,
"projectTaskId" : 5000123,
"assignment" : {
"id" : "5000130",
"code" : "ABC",
"description" : "Lorem ipsum",
"longDescription" : "Lorem ipsum",
"parent_id" : "5000130",
"parentType" : "Lorem",
"type" : "Lorem",
"customerId" : "5000130",
"modules" : "Lorem ipsum",
"assignments" : [ null, null ],
"params" : [ {
"type" : "{}",
"value" : "value"
}, {
"type" : "{}",
"value" : "value"
} ]
},
"ident" : 1,
"date" : "2020-01-23T04:56:07Z",
"duration" : 1,
"eventState" : "{}",
"datCre" : "2020-01-23T04:56:07Z",
"action" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem",
"regroup" : "Lorem"
},
"commentaire" : "Lorem ipsum",
"lieu" : "27 Rue Auguste Comte, 69002 Lyon, France",
"readOnly" : true,
"taskId" : 5000123,
"typeEvent" : "{}",
"action2" : {
"ident" : 1,
"code" : "ABC",
"name" : "Lorem"
},
"completionDate" : "2020-01-23T04:56:07Z"
}
2.19. User
2.19.1. Get user
GET |
/current_user |
Description
Get user
DMF required:
-
USERAK: A registered user.
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
User retrieved successfully |
|
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20. Versions
2.20.1. Get current version
GET |
/versions/current |
Description
Get current version
DMF required:
-
USERAK: A registered user.
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Current version retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20.2. Get current version for domain
GET |
/versions/current/{domain} |
Description
Get current version for domain
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
domain |
The domain |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Current version retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20.3. Get latest version
GET |
/versions/latest |
Description
Get latest version
DMF required:
-
USERAK: A registered user.
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Latest version retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20.4. Get latest version for domain
GET |
/versions/latest/{domain} |
Description
Get latest version for domain
DMF required:
-
USERAK: A registered user.
Parameters
Path Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
domain |
The domain |
X |
null |
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Latest version retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20.5. Get my On boarding News
GET |
/versions/on-boarding-news/mine |
Description
Get my On boarding News
DMF required:
-
USERAK: A registered user.
Return Type
array[MobOnBoardingNews]
Content Type
-
application/json
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
My On boarding News |
List[MobOnBoardingNews] |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
2.20.6. Get versions
GET |
/versions |
Description
Get versions
DMF required:
-
USERAK: A registered user.
Responses
| Code | Message | Datatype |
|---|---|---|
204 |
Versions retrieved successfully |
<<>> |
400 |
Bad Request - Standard failure code. This code is used when no other specific code applies. |
|
401 |
Unauthorized - indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource. |
|
402 |
Request Failed - The parameters were valid but the request failed. |
|
403 |
Forbidden - The user does not have permissions to perform the request. |
|
404 |
Not Found - The requested resource does not exist. |
|
405 |
Method Not Allowed - The HTTP method requested on the resource is not supported, for example if you make a POST request on a resource where POST does not make sense or is not implemented. |
|
406 |
Not Acceptable - The requested resource is capable of generating only content not acceptable according to the Accept headers sent in the request. |
|
500 |
Internal Error - Server errors. The call was successful but something went wrong on Akuiteo’s end. |
3. Models
3.2. AccountingJournal
Accounting journal
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The accounting journal code |
|||
endDate |
End date of. Cannot be set directly please use the //TBD path. |
date |
||
excludedByDefault |
Excluded by default from accounting reports (trial balance, General ledger, accounting entries seach) |
|||
id |
Id in database |
|||
miscellaneousTransactionsProhibited |
Miscellaneous transactions Prohibited |
|||
name |
The accounting journal name |
|||
startDate |
Accounting journal start date |
date |
3.3. AccountingJournalBase
Accounting journal
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The accounting journal code |
|||
id |
Id in database |
|||
name |
The accounting journal name |
3.4. Action
Verb of the request to specify which type of action you will send.
Type : enum (ADD, UPDATE, REMOVE)
3.5. ActionCode2
Details about the second action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the second action code |
|||
id |
Id in database |
|||
name |
Name of the action code |
3.6. ActionCodeBase
Details about the action code
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the action code |
3.7. ActionManagementObjectLine
ActionManagementObjectLine
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.8. ActiveModule
List of active modules
Note: MISSION represents the Variable Item
Type : enum (EXPENSE_REPORTS, TIMES_RECORDING, SCHEDULE, QUOTATION, QUOTATION_SIGNED_ORDERED_UNSIGNED, SALES_ORDER, INVOICE, SALES_BILLING_TABLE, DELIVERY, PURCHASE_ORDER, QUOTE, RECEPTION, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, HELP_DESK, PRODUCTION, MISSION, QUOTE_SIGNED_ORDERED_UNSIGNED, SALES_CREDIT_NOTE, PURCHASE_CREDIT_NOTE, INVENTORY_MOVEMENTS, FLOWS, ACCOUNTING, CASH_FLOW, OPERATING_ACCOUNT, PAYMENT_MONTH)
3.9. ActivityBase
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the activity |
|||
id |
Id in database |
|||
name |
Name of the activity |
3.10. AdditionalFreeFields
Free fields of a Management Object Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
field1 |
Free field 1 |
|||
field2 |
Free field 2 |
|||
field3 |
Free field 3 |
|||
field4 |
Free field 4 |
|||
field5 |
Free field 5 |
3.11. AdditionalFreeFieldsCriteria
Search criteria for additional free fields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalFreeField1 |
||||
additionalFreeField2 |
||||
additionalFreeField3 |
||||
additionalFreeField4 |
||||
additionalFreeField5 |
3.12. Address
Details about the address
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
cedex |
Special number assigned to a company by the French postal code |
|||
city |
City of the address |
|||
country |
Country code of the address in the database |
|||
countryName |
Country name of the address |
|||
department |
Geographical department code of the address in the database |
|||
Email of the address |
||||
fax |
Fax of the address |
|||
geographicalDepartmentName |
Name of the geographical department for the address |
|||
id (Deprecated) |
Id in database |
|||
line1 |
First line of the address |
|||
line2 |
Second line of the address |
|||
line3 |
Third line of the address |
|||
mobilePhone |
Mobile Phone of the address |
|||
phone |
Phone of the address |
|||
phone2 |
Second phone of the address |
|||
postalCode |
Postal code of the city |
|||
region |
Region code of the address in the database |
|||
regionName |
Region name of the address |
|||
webSite |
Web Site of the address |
3.13. Alert
Alert message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
level |
Level of the alert |
Enum: ERROR, WARNING, INFO, ERROR, WARNING, INFO |
||
message |
Message of the alert |
3.16. AnalysisResult
Analysis result consisting of a value, a date and a set of analysis groups
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Aggregate date of the analysis (see dateLike) |
date-time |
||
group |
Map of [object] |
All analysis groups |
||
value |
Aggregate value of the analysis |
double |
3.17. ApplicationControlBase
Application control
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the application control base. |
|||
id |
Id in database |
|||
info1 |
The first information about the application control base. |
|||
info2 |
The second information about the application control base. |
|||
info3 |
The third information about the application control base. |
|||
info4 |
The fourth information about the application control base. |
|||
info5 |
The fifth information about the application control base. |
3.18. ApplicationFeature
Application Feature
Type : enum (EXPENSES, EXPENSES_BY_EXPENSE_TYPE, EXPENSE_REPORT_TERMINATION, EXPENSE_REPORT_TERMINATION_CANCEL, EXPENSE_MOVE, EXPENSE_SMART_SCAN, TIMES_SCHEDULES, TIMESHEET_ENTRY_COMPLETION_CANCEL, TIMES, SCHEDULES, LEAVES, COMMANDS, REPORT_ERRORS, REMOTE_WORK, BUSINESS_CARD, PUISSANCE_FISCALE_PAR_VEHICULE, CUSTOM_REQUESTS)
3.19. ApprovalManagementObject
Information on the approval of a management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
type |
Example : QUOTATION |
3.20. ApprovalState
State of the Approval
Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)
3.21. ArchiveArgument
Arguments to archive
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment to describe the archiving reason |
|||
reasonId |
The ID of the archiving reason |
3.22. ArchiveReasonBase
Details about the reasons to archive
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the reason to archive |
|||
id |
Id in database |
|||
name |
Name of the reason to archive |
3.23. Assignment
Assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
3.24. AssignmentCriteria
Criteria used to get more details about an assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activityId |
Ident of the activity |
|||
allCompanies |
Set as True if you don't want to filter on companies |
|||
companyId |
Ident of the company |
|||
countAssignmentType |
Define the node type when counting an assignment tree. Used like a query parameter limit. |
|||
customerId |
Ident of the customer |
|||
departmentId |
Ident of the department |
|||
divisionGroupId |
Ident of the division group |
|||
divisionId |
Ident of the division |
|||
employeeId |
ID of the employee |
|||
employeeIdScheduled |
List of [string] |
Ids of employees for which the project has schedules |
||
employeePartitioning |
Set as True if you want to apply the partitioning by employee |
|||
entityId |
Ident of the entity |
|||
ignoreProjectAllCustomer |
Set as True if you want to ignore all customer projects |
|||
lowerAssignmentType |
Define the leaf node type when searching an assignment tree. If not set, default leaf node type is SUBPHASE or PROJECT_TASK according to the selected ActiveModule. |
|||
mainCustomer |
Set as True if you want to filter only main customers |
|||
phaseCode |
Code of the phase |
|||
phaseId |
Ident of the phase |
|||
projectCategorieId |
Ident of the project category |
|||
projectClosed |
Set as True if you want to include closed projects |
|||
projectEmployeeLinkedId |
Ids of employees linked to the project (Include projects with no employee linked) |
|||
projectFilterType |
Filter on project (may override some other clauses like divisionId or entityId) |
|||
projectFinancialManagerId |
Ident of the project financial manager |
|||
projectGroupCode |
Code of the project group |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectInternal |
Set as True if you want to include internal projects |
|||
projectManagerId |
Ident of the project manager |
|||
projectOnLeave |
Set as True if you want to include leave projects |
|||
projectProductionManagerId |
Ident of the project production manager |
|||
projectSalesManagerId |
Ident of the project sales manager |
|||
projectStateCode |
Code of the projectState |
|||
projectSubCategorieId |
Ident of the sub-category |
|||
projectSubcategorieLevel2Id |
Ident of the sub-category level 2 |
|||
projectTaskEmployeeLinkedId |
Ids of employees linked to the project task (Include project tasks with no employee linked) |
|||
projectTaskId |
Ident of the task |
|||
referentialDate |
Start referential date. If the field is not filled in, it take today's date by default |
date-time |
||
referentialDateEnd |
End referential date. This date must be after the referentialDate. |
date-time |
||
scheduled |
Assignment with schedules over the period (see referentialDate) |
|||
subPhaseCode |
Code of the sub-phase |
|||
subPhaseId |
Ident of the sub-phase |
|||
tag |
You can fill in the code or name of the assignment in this field |
|||
tagIdScheduled |
List of [string] |
Ids of tag for which the project has scheduled tags |
||
upperAssignmentType |
Define the root node type when searching an assignment tree. If this field is not filled in, default root node type is CUSTOMER. |
|||
yearId |
Ident of the year |
3.25. AssignmentIndicator
The project indicator.
By default, this field contains the value 'SINGLE_PROJECT_MONO_PHASE'.
If this field is on 'SINGLE_PROJECT_MONO_PHASE', it is mandatory to enter the projet_id, phase_id and subphase_id in the quotation.
If this field is on 'SINGLE_PROJECT_MULTI_PHASES', it is mandatory to enter the project_id in the quotation and it is not possible to enter the phase_id and subphase_id in the quotation but only in the quotation line.
If this field is on 'MULTI_PROJECTS', it is not possible to enter the projet_id, phase_id and subphase_id in the quotation but it is mandatory to write them in the quotation line.
Type : enum (SINGLE_PROJECT_MONO_PHASE, SINGLE_PROJECT_MULTI_PHASES, MULTI_PROJECTS)
3.26. AssignmentNode
Assignment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalProperties |
Map of [string] |
Additonal functional properties available on this node |
||
assignments |
List of AssignmentNode |
Assignment node's child |
||
code |
Code of the assignment |
|||
description |
Short description of the assignment |
|||
id |
Id in database |
|||
longDescription |
Long description of the assignment |
|||
parentId |
ID of the parent |
|||
parentType |
Details about the parent |
|||
selectable |
Return True if the assignment node can be selected |
|||
type |
Details about the assignment type |
3.27. AssignmentReferential
Assignment referential
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activity |
Details about the activity |
|||
category |
Details about the category |
|||
company |
Details about the company |
|||
customer |
Details about the customer |
|||
department |
Details about the departement |
|||
division |
Details about the divison |
|||
divisionGroup |
Details about the division grouping |
|||
entity |
Details about the entity |
|||
id |
Id in database |
|||
phase |
Details about the phase |
|||
project |
Details about the project |
|||
projectGroup |
Details about the project group |
|||
projectManager |
Details about the project manager |
|||
projectProductionManager |
Details about the production manager |
|||
projectState |
Details about the project state code |
|||
projectTask |
Details about the task |
|||
subCategory |
Details about the sub-category |
|||
subCategoryLevel2 |
Details about the second sub-category |
|||
subPhase |
Details about the sub-phase |
|||
year |
Details about the year |
3.28. AssignmentSubType
Subtype of Assignment
Type : enum (PROJECT_GROUP, DEPARTMENT, ACTIVITY, CATEGORY, SUB_CATEGORY, SUB_CATEGORY_2, PROJECT_STATE, YEAR)
3.29. AssignmentType
Type of Assignment
Type : enum (COMPANY, DIVISION_GROUP, DIVISION, ENTITY, CUSTOMER, PROJECT, PHASE, SUBPHASE, PROJECT_TASK)
3.30. AttachFileLocation
If ATTACH, the file will be added as an attachement. If BODY the report will be integrated into the email's body.
Type : enum (BODY, ATTACH)
3.31. Avatar
Entity avatar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
content |
The base64-encoded binary content or URL of the entity's avatar image. |
3.32. AxeCriteria
Standard criteria for filtering data from the analysis
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
axeType |
X |
Unused (technical field) |
||
customerAccountManagerId |
Ident of customer's account manager |
|||
customerAccountManagerSupervisorId |
Ident of customer's account manager supervisor |
|||
customerCountryId |
Ident of customer's country |
|||
customerFamilyId |
Ident of the customer's project category |
|||
customerGrouping1 |
Customer's grouping |
|||
customerGrouping2 |
Customer's grouping 2 |
|||
customerId |
Ident of customer |
|||
customerRegionId |
Ident of customer's address region |
|||
customerSalesmanId |
Ident of customer's salesman |
|||
customerSalesmanSupervisorId |
Ident of customer's salesman supervisor |
|||
customerSectorId |
Ident of customer's sector |
|||
customerState |
Customer's state |
|||
customerSubFamilyId |
Ident of the customer's project subcategory |
|||
groupCustomer |
Group of companies of the customer |
|||
phaseId |
Ident of the phase |
|||
projectActivityId |
||||
projectCampaignId |
Ident of the project's compaign |
|||
projectCompanyCode |
Code of the project's company |
|||
projectDepartmentId |
Ident of the project's department |
|||
projectDivisionGroupId |
Ident of the project's division group |
|||
projectDivisionId |
Ident of the project's division |
|||
projectEstablishmentId |
||||
projectFamilyId |
Ident of the project's category |
|||
projectFinancialManagerId |
Ident of the project's financial manager |
|||
projectId |
Ident of the project (equivalent to the code of the project) |
|||
projectManagerId |
Ident of the project manager of the project |
|||
projectMarketId |
Ident of project group of the project |
|||
projectProductionManagerId |
Ident of the project's product manager |
|||
projectSalesManagerId |
Ident of the project's sales manager |
|||
projectState |
State of project |
|||
projectSubFamily2Id |
Ident of the project's sub-category level 2 |
|||
projectSubFamilyId |
Ident of the project's sub-category |
|||
projectVintageId |
Ident of the year (vintage) of the project |
|||
prospect |
True is customer is a prospect |
|||
subPhaseId |
Ident of the sub-phase |
3.33. AxeGroupsType
Standard analysis axis
Type : enum (PROJECT_ID, PROJECT_NAME, PROJECT_COMPANY_CODE, PROJECT_DIVISION_GROUP_ID, PROJECT_DIVISION_GROUP_NAME, PROJECT_DIVISION_ID, PROJECT_DIVISION_NAME, PROJECT_ESTABLISHMENT_ID, PROJECT_ESTABLISHMENT_NAME, PROJECT_ACTIVITY_ID, PROJECT_ACTIVITY_NAME, PROJECT_DEPARTMENT_ID, PROJECT_DEPARTMENT_NAME, PROJECT_FAMILY_ID, PROJECT_FAMILY_CODE, PROJECT_SUB_FAMILY_ID, PROJECT_SUB_FAMILY_CODE, PROJECT_SUB_FAMILY2_ID, PROJECT_SUB_FAMILY2_CODE, PROJECT_VINTAGE_ID, PROJECT_VINTAGE_CODE, PROJECT_MANAGER_ID, PROJECT_MANAGER_CODE, PROJECT_SALES_MANAGER_ID, PROJECT_SALES_MANAGER_CODE, PROJECT_FINANCIAL_MANAGER_ID, PROJECT_FINANCIAL_MANAGER_CODE, PROJECT_PRODUCTION_MANAGER_ID, PROJECT_PRODUCTION_MANAGER_CODE, PROJECT_CAMPAIGN_ID, PROJECT_CAMPAIGN_CODE, PROJECT_STATE, PROJECT_MARKET_ID, PROJECT_MARKET_CODE, PROJECT_MARKET_NAME, PHASE_ID, PHASE_CODE, PHASE_NAME, SUB_PHASE_ID, SUB_PHASE_CODE, SUB_PHASE_NAME, CUSTOMER_ID, CUSTOMER_CODE, CUSTOMER_NAME, CUSTOMER_FAMILY_ID, CUSTOMER_FAMILY_CODE, CUSTOMER_SUB_FAMILY_ID, CUSTOMER_SUB_FAMILY_CODE, CUSTOMER_GROUPING_1, CUSTOMER_GROUPING_2, CUSTOMER_SECTOR_ID, CUSTOMER_SECTOR_CODE, CUSTOMER_STATE, CUSTOMER_COUNTRY_ID, CUSTOMER_COUNTRY_NAME, CUSTOMER_COUNTRY_CODE, CUSTOMER_REGION_ID, CUSTOMER_REGION_CODE, CUSTOMER_ACCOUNT_MANAGER_ID, CUSTOMER_ACCOUNT_MANAGER_CODE, CUSTOMER_SALES_MAN_ID, CUSTOMER_SALES_MAN_CODE, CUSTOMER_ACCOUNT_MANAGER_SUPERVISOR_ID, CUSTOMER_ACCOUNT_MANAGER_SUPERVISOR_CODE, CUSTOMER_SALES_MAN_SUPERVISOR_ID, CUSTOMER_SALES_MAN_SUPERVISOR_CODE, CUSTOMER_PROSPECT, CUSTOMER_OPENING_DATE, CUSTOMER_PROFESSION, CUSTOMER_PROFESSIONAL_CATEGORY)
3.34. BIC
Details about the BIC of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bank |
Code of the bank - 4 digits max |
|||
branch |
Code of the optional branch - 3 digits max |
|||
country |
Country code of the address in the database |
|||
location |
Code of the location - 2 digits max |
3.35. BankDetails
Details about the bank of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number - 11 digits max |
|||
counter |
Code of the counter - 5 digits max |
|||
domiciliation |
Bank domiciliation |
|||
entity |
Code of the bank - 5 digits max |
|||
key |
Key of the RIB - 2 digits max |
3.36. BankType
Type of the bank (nature de banque) for international bank detail
Type : enum (BIC, ABA, NOT_DEFINED)
3.37. BankingInformation
Banking informations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
id |
ID in database |
|||
noneSepa |
Details about the none SEPA banking information (exclusive with the sepa field) |
|||
sepa |
Details about the SEPA banking information (exclusive with the noneSepa field) |
|||
statusChangeArgument |
Argument to change the status of a banking information |
|||
statusChangeDate |
This field is automatically set with the validation date when the Banking Information is validated or with the rejection date when the Banking Information is refused. |
date-time |
||
type |
The type of banking information used to indicate whether the data refers to SEPA details (with BIC, IBAN, and bankDetails) or international bank details. |
|||
validator |
Details about the employee who will validate banking data. |
|||
validatorId |
Set as true if this rule for validating banking data is applied to employees. |
3.38. BankingInformationStatus
The status of the Banking Information
Type : enum (VALIDATED, TO_VALIDATE, REFUSED)
3.39. BankingInformationStatusParamHolder
Argument to change the status of a banking information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment about the change status |
|||
status |
X |
The status of the Banking Information |
3.40. BankingInformationSupplierType
Supplier type of banking information
Type : enum (ALL, INTERNAL, EXTERNAL, VIRTUAL)
3.41. BankingInformationType
List of banking information type
Type : enum (SEPA, INTERNATIONAL_BANK)
3.42. BaseRateBase
Basic information for rates.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID in database of base rate |
|||
name |
The description of the base rate |
3.43. BatchArchiveArgumentParamHolder
The parameters for archiving the quotations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
archiveArgument |
The argument for archiving |
|||
ids |
List of [string] |
IDs of the elements to archive |
3.44. BatchParameter
Parameter used to manage batch operations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Ids of the objects |
3.45. BatchUpdateCustomDataParamHolder
All the information to perform the batch update on custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customData |
X |
Map of CustomData |
All custom data to update |
|
ids |
X |
List of [string] |
List of id on which the update must be done |
3.46. BatchUpdateSalesMObjectLines
Object for batch updating certain fields in sales management object lines
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingMode |
Billing mode for the line |
|||
ids |
List of [string] |
Ids of the objects |
||
notPublishable |
Set to “true” if the line is not to be shown when the sales management object containing said line (quotation, invoice, etc.) is published. |
|||
resourceId |
Id of the resource allocated to complete the task |
3.47. BillingMode
Billing mode of a product or sales line
Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT, PRODUCTION_TO_BE_BILLED)
3.48. BlockedType
Type of object to be tested in the customer blocking control
Type : enum (OPPORTUNITY, QUOTATION, DELIVERY, PURCHASE_BILLING_TABLE, SALES_INVOICE, PROJECT, TRAINING_OPPORTUNITY, REGISTRATION_FORM, CUSTOMER_CONTRAT)
3.49. BlockingInformation
Blocking information (Customer, …)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
alerted |
Operation is not blocked for this customer but has alerts. |
|||
blocked |
X |
Operation is blocked for this customer. |
||
reason |
Reason why customer is blocked. |
3.50. BlockingParamHolder
Blocking information needed to apply checking
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
X |
Amount to be checked |
double |
|
objectId |
Object tested (only in modifcation) |
|||
objectType |
X |
Type of parameterized object tested |
3.51. BooleanParamHolder
Parameter value (Boolean).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.52. BusinessEntity
BusinessEntity manages project-related information, including its phases and sub-phases.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.53. BusinessReferential
BusinessReferential manages project-related information, including phases, sub-phases, and associated project tasks.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.54. Calendar
Calendar
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the calendar. |
|||
daysNotWorked |
List of [integer] |
Days not worked (ISO day of the week with 1 being Monday and 7 being Sunday) |
int32 |
|
default |
Set as 'true' to use this calendar by default. |
|||
holidays |
List of Holiday |
Details about list of holidays. |
||
id |
Id in database |
|||
name |
The name of the calendar. |
3.55. CalendarEvent
CalendarEvent
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.56. CampaignBase
Marketing campaign
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the campaign. |
|||
id |
ID in database |
|||
name |
The name of the campaign. |
3.57. Category
Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the category |
|||
companyCode |
The code of the company |
|||
endDate |
End date for using the category of the product |
date |
||
grouping |
Grouping field for category |
|||
id |
Id in database |
|||
name |
The name of the category |
|||
ranking |
Category ranking in help lists |
int32 |
||
type |
Type of the category. |
3.58. CategoryCriteria
Criteria used on Category when doing a Category search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the category |
|||
companyId |
Company of the category |
|||
endDate |
End date of validity for the category |
|||
grouping |
Grouping field of the category |
|||
id |
Ident of the category |
|||
name |
Name of the category |
|||
tag |
You can fill in the code or name of the category in this field |
|||
type |
Type of the category |
|||
validity |
Details about the validity of the category |
3.59. CategoryType
Type of category
Type : enum (SALES_ITEM, PURCHASE_ITEM, PROJECT_CATEGORY, PROJECT_SUB_CATEGORY, PROJECT_SUB_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL1, EMPLOYEE_CATEGORY_LEVEL2, EMPLOYEE_CATEGORY_LEVEL3, CUSTOMER, TECHNICAL_DOMAIN, OTHER_THIRDPARTIES, WORKGROUP, VERSION, CUSTOMERS_CONTRACTS, RETAILER_CONTRACTS, DOCUMENT, TRAINING_ITEM, SUPPLIER, MAINTAINED_ITEM)
3.60. ChangeTracking
History of all changes made
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdBy |
Code of the creator (user) |
|||
createdById |
Id of the creator (user) |
|||
createdTime |
Creation Date |
date-time |
||
modificationBy |
Code of the user who did the modification |
|||
modificationById |
Id of the user who did the modification |
|||
modificationTime |
Date of the modification. |
date-time |
3.61. ChangeTrackingCriteria
Standard criteria for filtering data from the change tracking
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createdById |
The ID of the user who created the object. |
|||
createdTime |
The date and time when the object was created. |
|||
updatedById |
The ID of the user who last updated the object. |
|||
updatedTime |
The date and time when the object was last updated. |
3.62. CheckbookBase
Customer checkbook base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
The name of the checkbook |
3.63. ChorusInvoiceStatus
Chorus status for e-invoices sent
Type : enum (DRAFT, SUBMITTED, IN_TRANSIT, AVAILABLE, COMPLETED, TO_BE_RECYCLED, SUSPENDED, REJECTED, SERVICE_RENDERED, MANDATED, AVAILABLE_FOR_ACCOUNTING, ACCOUNTED, PAYMENT_INITIATED)
3.64. ChorusServiceInformation
Chorus service information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
serviceCode |
Code of Chorus service |
|||
serviceName |
Name of Chorus service |
3.65. City
City
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
The code of the company linked to the city |
|||
country |
The country where the city is located |
|||
countryId |
Id of the country where the city is located |
|||
default |
Returns true if the city is the default city |
|||
department |
The department where the city is located |
|||
departmentId |
Id of the department where the city is located |
|||
id |
Id in database |
|||
latitude |
Latitude of the city |
|||
longitude |
Longitude of the city |
|||
name |
Name of the city |
|||
postcode |
Postcode of the city |
|||
regionId |
Id of the region |
3.66. Clause
Basic clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search |
3.67. ClauseBoolean
Boolean clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
3.68. ClauseDate
String clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
date-time |
|
withTime |
Whether or not the time part should be taken into account (false by default) |
3.69. ClauseDouble
Double clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
3.70. ClauseOperation
Operation used by the clause
Type : enum (LIKE, NOT_LIKE, IS, IS_NOT, IN, NOT_IN, IS_NULL, IS_NOT_NULL, CLAUSES, GREATER_OR_EQUALS, GREATER, LOWER_OR_EQUALS, LOWER)
3.71. ClauseString
String clause type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeNullResults |
Set as true to include null results |
|||
operator |
X |
The operator for your operation. |
||
value |
X |
The value you search. |
||
wildcards |
When using the LIKE operator, indicates which characters should be interpreted as wildcards ('*%_' by default) |
3.72. ColorCodes
ColorCodes
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color1 |
First color code |
|||
color2 |
Second color code |
|||
color3 |
Third color code |
3.73. Command
Command
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
End of the command |
date-time |
||
error |
Error of the command |
|||
id |
The Id of the command |
|||
progress |
Progress of the command |
|||
result |
Result of the command |
|||
startDate |
Start of the command |
date-time |
||
status |
Status of the command |
Enum: STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR, STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR |
3.74. CommandProgress
Command progress status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
current |
Current index of the progress |
|||
max |
Max index of the progress |
3.75. Company
Company (Société)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
address |
The company's main address |
|||
addressId |
The id of the company's main address |
|||
calendar |
Details of the calendar |
|||
calendarId |
ID of the calendar |
|||
code |
Code of the company |
|||
color |
Color attached to the company |
|||
currency |
Details about the currency |
|||
currencyId |
The currency id |
|||
id |
Id in database |
|||
legalName |
Legal name of the company |
|||
name |
Name of a company |
|||
siren |
SIREN number |
|||
siret |
SIRET number |
3.76. CompanyBase
Company
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the company |
|||
id |
Id in database |
|||
name |
Name of a company |
3.77. ComparisonOperator
Comparison operator
Type : enum (BEFORE, AFTER, EQUAL, BEFORE_EQUAL, AFTER_EQUAL)
3.78. ConditionOfPayment
The condition of payment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
term |
Period of payment |
3.79. ContactBase
Contact
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the contact. |
|||
firstName |
The first name of the contact. |
|||
id |
Id in database |
|||
name |
The name of the contact. |
3.80. ContractBase
Contracts
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details of the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
afterTaxAmountCurrency |
After-Tax amount in the currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
assignmentIndicator |
Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project. |
|||
changeTracking |
||||
code |
Code of the contract |
|||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
conditionOfPayment |
||||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
exchangeRate |
The currency's exchange rate |
double |
||
fiscalYear |
Belonging fiscal year |
|||
fiscalYearId |
Id of the fiscalYear |
|||
group |
Group object |
|||
id |
Id in database |
|||
internal |
Internal object |
|||
manager |
Details of the employee |
|||
managerId |
Id of the manager |
|||
methodOfPayment |
Method of payment |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
payment (Deprecated) |
Deprecated : Use conditionOfPayment instead |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
preTaxAmountCurrency |
Pre-Tax Amount in the currency |
double |
||
pricingMethod |
Details about the pricing method. The method by which pricing is to be determined. |
|||
pricingMethodId |
The id of the pricing method |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
thirdPartyToBillId |
The Id of the third-party to bill |
|||
type |
Example : QUOTATION |
3.81. ContractServiceBase
Contact service (basic information)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the contract service. |
|||
id |
Id in database |
|||
name |
The name of the contract service. |
3.82. ControlBehavior
Field control behavior
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalValueSelectors |
List of [string] |
Additional information related to the valueSelectors, providing context or supplementary details for the list of permissible values. |
||
allowMultipleValues |
Set as 'true' if the user is allowed to select multiple values from the valueSelectors. |
|||
defaultValue |
Default value of the field |
|||
enabled |
Return true if the field is enabled |
|||
freeValue |
Set as 'true' if the user is not restricted to the values listed in valueSelectors and can set a freely chosen value. |
|||
id |
ID of the control behavior |
|||
information |
Additional information of the field |
|||
property |
Name of the property controlled |
|||
required |
Return true if the field is required |
|||
valueSelectors |
List of [string] |
Customizable list of values for selection, allowing the restriction of permissible values in fields. |
||
visible |
Return true if the field is visible |
3.83. Country
Country
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
calendar |
The calendar of the company linked to the country |
|||
calendarId |
Id of the calendar |
|||
code |
Code of the country |
|||
companyCode |
The code of the company linked to the country |
|||
companyId |
ID of the company |
|||
continent |
The continent where the country is located |
|||
currency |
The country's currency |
|||
currencyId |
Id of the country's currency |
|||
id |
Id in database |
|||
isPartOfEU |
Returns true if the country is part of the European Union |
|||
name |
Name of the country |
3.84. Currency
Currency
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the currency |
|||
endDate |
End date for using the currency |
date-time |
||
euro |
Returns true if the currency is in euro |
|||
euroRate |
Exchange rate against the euro. |
double |
||
euroRateEndDate |
End date of the exchange rate (euroRate field). |
date-time |
||
euroRateStartDate |
Start date of the exchange rate (euroRate field). |
date-time |
||
id |
Id in database |
|||
name |
Name of the currency |
|||
order |
Order number of the currency |
3.85. CustomData
Custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
label |
Label of the custom data |
|||
name |
Name of the custom data |
|||
realOrder |
Order number to display |
int32 |
||
type |
Type of the custom data |
|||
value |
Value of the custom data |
3.86. CustomDataPage
Page of the custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
columnNumber |
Number of custom data page columns. |
|||
id |
ID of the custom data page |
|||
name |
The name of the custom data page. |
|||
order |
The order (ranking) of the custom data page. |
int32 |
3.87. CustomDataParam
Description of a parameter of custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID of the custom data |
|||
keywordId |
ID of the keyword |
|||
label |
Label of the custom data |
|||
multiLine |
True if custom data is multi line |
|||
name |
Name of the custom data |
|||
order |
Order of the custom data |
int32 |
||
page |
Page of the custom data |
|||
pageId |
ID of the page |
|||
pattern |
Validation pattern of the custom field |
|||
property |
Property of the custom data |
|||
realOrder |
Real order of the custom data |
int32 |
||
section |
Section of the custom data |
|||
sectionId |
ID of the section |
|||
sequence |
Sequence of the custom data |
int32 |
||
textLimit |
Text limit of the custom data |
int32 |
||
type |
Type of the custom data |
|||
viewLabel |
True if label is visible |
3.88. CustomDataPattern
Custom data pattern
Type : enum (DATE_TIME, UPPER_CASE, LOWER_CASE, PROPER_CASE, PHONE, INTEGER, INTEGER_THOUSAND_SEPARATOR, INTEGER_ZERO_NOT_SIGNIFICANT, TWO_DIGITS_AFTER_DECIMAL_POINT, THREE_DIGITS_AFTER_DECIMAL_POINT, CURRENCY, CURRENCY_ZERO_NOT_SIGNIFICANT, URL, PERCENTAGE, PERCENTAGE_ONE_DIGIT, PERCENTAGE_TWO_DIGITS, PERCENTAGE_THREE_DIGITS, SIGNATURE, PASSWORD)
3.89. CustomDataSection
Section for custom data
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
columnNumber |
Column number of the custom data section |
|||
id |
ID of the custom data section |
|||
name |
Name of the custom data section |
|||
order |
Order number of the custom data section |
int32 |
||
pageId |
ID of the page |
|||
type |
By default set as SECTION |
3.90. CustomDataSectionType
SECTION to add the custom data into a section label;
COMPOSITE to add the custom data one after the other, without grouping them under a section label.
Type : enum (SECTION, COMPOSITE)
3.92. CustomerBase
Customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.93. CustomerIndicator
Customer Indicator
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
Set as true to use this customer indicator by default. Set as false by default |
|||
code |
Code of the Customer Indicator |
|||
colorHexCode |
The Hexadecimal color code for this customer Indicator |
|||
customerId (Deprecated) |
ID of the Customer |
|||
id |
Id in database |
|||
name |
Name of the Customer Indicator |
|||
order |
The order (ranking) of this customer indicator |
int32 |
3.94. CustomerIndicatorCriteria
Criteria used to get more details about the customer indicator
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
True if customer indicator is by default |
|||
code |
||||
colorHexCode |
||||
id |
||||
name |
3.95. CustomerIndicators
Indicators of a customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerId |
ID of the Customer |
|||
indicator1 |
The first indicator |
|||
indicator2 |
The second indicator |
|||
indicator3 |
The third indicator |
3.96. CustomerSiteBase
Customer Sites
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the customer site |
|||
customer (Deprecated) |
Details about the customer |
|||
customerId (Deprecated) |
Code of the associated customer |
|||
id |
Id in database |
|||
name |
Name of the customer site |
3.97. CustomerStatus
Customer Status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Customer Status |
|||
companyId |
ID of the company |
|||
endDate |
The end date of the customer status. |
date-time |
||
id |
Id in database |
|||
name |
Name of the Customer Status |
|||
ranking |
The customer status ranking in the list |
int32 |
3.98. CustomizableResources
Customizable resources (Ressources personnalisables)
Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT, PROJECT, PHASE, SUB_PHASE, EMPLOYEE, CUSTOMER, CONTACT, SALES, PURCHASE)
3.99. DateParamHolder
Date given in parameter
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date |
date-time |
3.101. Department
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activities |
List of ActivityBase |
Activities of the department |
||
analysis |
Analysis of the department |
|||
code |
Code of the department |
|||
comment |
Comment of the department |
|||
companyCode |
Code of the company |
|||
entity |
Details of the entity |
|||
entityId |
ID of the entity |
|||
id |
Id in database |
|||
name |
Description of the department |
|||
projectType |
Type of the project |
3.102. Discount
Discount on a Management Object Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
The discount amount |
double |
||
amountCurrency |
The discount amount in the currency |
double |
||
percentage |
The discount percentage |
double |
||
type |
Type of discount (PERCENT, AMOUNT) |
3.104. Division
Division
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a division |
|||
companyId |
Id of the company |
|||
group |
Details about the group |
|||
groupId |
ID of the group |
|||
id |
Id in database |
|||
name |
Name of a division |
3.105. DivisionGrouping
Division grouping
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a division grouping |
|||
id |
Id in database |
|||
name |
Name of a division grouping |
|||
serviceId |
ID of the service |
3.106. DmfBase
A dmf (a right in akuiteo D - Functional Area, M - Module, F - Feature)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the right(dmf). |
|||
id |
Id in database |
|||
name |
The name of the right(dmf). |
3.107. Document
Details about document (file or link)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Details about the action performed on the document |
|||
archived |
Return true if the document is archived. |
|||
category |
All details about the category of the product |
|||
category1 |
First category of the document |
|||
category2 |
Second category of the document |
|||
category3 |
Third category of the document |
|||
categoryId |
The Id of the category |
|||
changeTracking |
Creation and modification date and user |
|||
classification |
Classification of the document. |
|||
companyId |
ID of the company |
|||
description |
The description of the document |
|||
documentType |
Type of the document. |
|||
externalDMSUuid |
External ID when you use a DMS |
|||
fileName |
File name |
|||
fileUrl |
File url. This field cannot be updated once it has been created. |
|||
id |
Is of the document |
|||
lienUrl |
URL of the document |
|||
links |
List of DocumentLink |
Details about document's links |
||
locked |
Set as true if the document is locked. |
|||
original |
Return true if the document is an original. |
|||
owner |
Details about the publisher of the document. |
|||
ownerId |
ID of the owner of the document. |
|||
preview |
Preview of the document |
|||
publicationDate |
Publication date |
date-time |
||
publishedBy |
Details about the publisher of the document. |
|||
publishedById |
ID of the publisher of the document. |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subClassification |
Sub-classification of the document |
|||
title |
X |
Title of the document |
||
tokenPreview |
Token to request by url the preview of the document |
|||
url |
URL of the document |
|||
version |
Version of the document |
double |
||
versionId |
ID of the version |
3.108. DocumentLink
A link between a document and any other object
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
document |
Details about the document |
|||
documentId |
ID of the document |
|||
id |
ID of the link |
|||
objectId |
ID of the object linked to the document |
|||
objectType |
Details about the type of object linked |
|||
original |
Return true if the document is an original |
3.109. DocumentVersion
DocumentVersion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
classification |
Classification of the document. |
|||
documentId |
ID of the document |
|||
id |
Id in database |
|||
title |
Title of the document |
|||
version |
Version number |
double |
3.110. DueDate
Due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Amount to pay |
double |
||
currencyCode |
Code of the currency |
|||
date |
Due date |
date-time |
||
id |
Id in database |
|||
invoiceId |
ID of the invoice |
3.111. DueDateCriteria
Criteria used to get more details about the due date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
invoiceId |
Ident of the invoice |
3.112. Durations
Duration in different units
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
durationDay |
Duration in day |
double |
||
durationHour |
Duration in hour |
double |
||
durationHourMinute |
Duration in hour minute |
double |
||
durationMinute |
Duration in minute |
double |
3.113. DutiableCriteria
Search criteria for dutiable fields
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
forcedVat |
Forced VAT clause |
|||
vat1 |
VAT code 1 |
|||
vat2 |
VAT code 2 |
3.114. DutiableLine
Tax Line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
forcedVat |
Forced VAT for the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
||
vat1 |
Details about the first VAT rate |
|||
vat2 |
Details about the second VAT rate |
|||
vatAmount1 |
Amount expressed in company currency with the first VAT |
double |
||
vatAmount1Currency |
Amount in currency for the first VAT |
double |
||
vatAmount2 |
Amount expressed in company currency for the second VAT |
double |
||
vatAmount2Currency |
Amount in currency for the second VAT |
double |
3.115. ESignatureMessage
Message for electronic signature of a management object.
A message is a combination of a Mail (used to store standard information for sending a mail) and functional information. This functional information is processed by backend service to compute standard information for sending mail like an employee's email address.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ccRecipients |
List of MessageRecipient |
Cc mail recipients |
||
publishArguments |
Required arguments to publish a document |
|||
toRecipients |
List of MessageRecipient |
Main mail recipients |
3.116. ESignatureSignatoryType
Defines the type of signatory for electronic signatures.
A signatory can be either an employee or a contact.
Type : enum (CONTACT, EMPLOYEE)
3.117. ESignatureStatus
Electronic signature status of a management object
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, SIGNED, FAILED, PENDING, SIGNATURE_REQUESTED)
3.118. ESignatureTransaction
Information on transactions for electronic signatures
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
The date of the transaction |
date-time |
||
daysSpent |
Number of days since transaction was requested |
double |
||
id |
Id in database |
|||
ranking |
Rank number of transaction. |
int32 |
||
rejectionReason |
The reason for rejection if the signatory has refused to sign the document. |
|||
requesterId |
The ID of the the transaction requester. |
|||
signatoryEmail |
Signatory e-mail address |
|||
signatoryId |
The ID of th signatory |
|||
signatoryType |
The type of signatory for electronic signatures. |
|||
signatureDate |
The date of signature. |
date-time |
||
signatureStatus |
Status of the signature |
|||
status |
Status of the transaction |
3.119. EmployeeBase
Employees
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb |
|||
code |
Code of the employee |
|||
firstName |
First name of the employee |
|||
id |
Id in database |
|||
name |
Name of the employee |
3.120. Entity
Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the entity |
|||
companyId |
ID of the company |
|||
division |
Details of the division |
|||
divisionCode |
Code of the division |
|||
divisionId |
ID of the division |
|||
endDate |
End date of the entity |
date-time |
||
id |
Id in database |
|||
legalName |
Legal name of the entity |
|||
name |
The name of the entity |
3.121. EntityBase
Entity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the entity |
|||
id |
Id in database |
|||
name |
The name of the entity |
3.122. ErrorMessage
Error message for batch processing
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
ID of the object in error |
|||
message |
Detailed error message related to the identifier |
3.123. ErrorResponse
The canonical model for problem details is a JSON [RFC7159] object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
A human-readable explanation specific to this occurrence of the problem. |
|||
message |
A human-readable explanation specific to this occurrence of the problem. |
|||
status |
The HTTP status code ([RFC7231], Section 6) |
|||
timestamp |
Timestamp of the error |
date-time |
||
title |
A short, human-readable summary of the problem |
|||
type |
A URI reference [RFC3986] that identifies the problem type |
3.124. EventType
Type of event
Type : enum (COMMAND_TASK, COMPANY, CUSTOMER, SUPPLIER, DIVISION, DIVISION_GROUP, EMPLOYEE, EMPLOYEE_HISTORY, ENTITY, EXPENSE, EXPENSE_REPORTS, FEATURE_FLAG, INVOICES_CHECK, ISSUE, PHASE, PROJECT, PROJECT_TASK, SCHEDULE, SPRINT, SUB_PHASE, TASK, TIMERECORDING, DOCUMENT, YEAR, TITLE, FAMILY, SKILL, SERVICE, JOB_TYPE, STANDARD_WEEK, EXPENSE_PROFILE, LANGUAGE, PROJECT_OPTIONS, PROJECT_GROUP, ACTIVITY, DEPARTMENT, REFRESH_CQRS, SPRINT_CARD, WEBHOOK, CONTRACT, QUOTATION, SALES_ORDER, OPPORTUNITY, PURCHASED_ITEM, SOLD_ITEM, CONTACT, EVENT, ALL, SPRINT_CARD_GROUP)
3.125. ExchangeRate
Exchange Rate
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
currency |
Details about the currency |
|||
currencyId |
Id of the currency |
|||
endDate |
End date for using the exchange rate |
date-time |
||
id |
Id in database |
|||
rate |
Exchange rate to convert the amount from euro into an amount in the revelant currency |
double |
||
startDate |
Start date for using the exchange rate |
date-time |
3.126. ExpenseReceiptSummary
Details about the expense receipt
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Amount on the receipt |
double |
||
currencyCode |
Code of the currency |
|||
date |
Date of the document |
date-time |
||
expenseTypeCode |
Code of expense's type |
|||
filePath |
Path of the document |
|||
rebillable |
Return true if the expense can be rebilled |
3.127. FeatureFlag
Application feature
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
active |
If the feature is active |
|||
domain |
Feature classification (main level) |
|||
id |
Feature identifier |
|||
label |
Feature description |
|||
subDomain |
Feature classification (detail level) |
3.128. FieldError
Object containg the error for a field
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
elementId |
The id of the sub element in error (which can have several errors) |
|||
fieldName |
X |
The fieldName of the field in error |
||
message |
X |
The error message |
3.129. FinancialConditionOfPayment
The condition of payment for a customer
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
referenceOnBankStatement |
Reference on bank statement |
|||
term |
Period of payment |
3.130. FiscalYearBase
Fiscal Year
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the FiscalYear |
|||
id |
Id in database |
|||
journalEntryNumberingId |
Id of the JournalEntryNumbering |
|||
name |
Name of the FiscalYear |
3.131. FiscalYearCommon
Fiscal Year
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
closingDate |
Date on which the fiscal year is officially closed. |
date |
||
code |
Code of the FiscalYear |
|||
endDate |
Fiscal year's end date |
date |
||
id |
Id in database |
|||
journalEntryNumberingId |
Id of the JournalEntryNumbering |
|||
name |
Name of the FiscalYear |
|||
startDate |
Fiscal year's start date |
date |
3.132. FixedAssetRecordSheetBase
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
3.133. FixedAssetRecordSheetCommon
Fixed asset record sheet
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of fixed asset record sheet |
|||
number |
Number of fixed assets |
3.135. ForcedVatAmountHolder
VAT Amount and forced indicator holder
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amount |
Forced amount |
double |
||
forced |
X |
Returns true if the amount is forced |
||
managementObjectLineId |
ID of the management object line |
3.136. FormConfig
Form Config
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controls |
Map of ControlBehavior |
Details about the control behavior linked to the field |
||
deletable |
Deletion allowed |
|||
editable |
Update allowed |
|||
fields (Deprecated) |
List of ControlBehavior |
Details about the control behavior linked to the field |
||
formSearchHidden |
Form search hidden |
|||
insertable |
Creation allowed |
|||
type |
Type of the formConfig |
3.137. FormConfigType
Type of form config
Type : enum (TIMESHEET, SCHEDULE, PROJECT, SEARCH_PROJECT, PHASE, SUB_PHASE, PROJECT_TASK, SEARCH_PROJECT_TASK, SEARCH_EMPLOYEE, EMPLOYEE, SEARCH_CUSTOMER, CUSTOMER, SEARCH_CONTACT, CONTACT, SEARCH_EVENT, EVENT, SEARCH_ISSUE, ISSUE, ISSUE_TASK, SEARCH_SPRINT_CARDS, LEAVE_REQUEST, CUSTOM_REQUEST, SEARCH_PROJECT_EVENT, SEARCH_LEAVE_REQUEST_EMPLOYEE, SEARCH_LEAVE_REQUEST_MANAGER, SEARCH_APPROVAL, SEARCH_TIMESHEET_ENTRY, SEARCH_SCHEDULE, SEARCH_EXPENSE_REPORT_EMPLOYEE, SEARCH_EXPENSE_REPORT_MANAGER, SEARCH_CUSTOM_REQUEST, OPPORTUNITY, OPPORTUNITY_LINE, QUOTATION, QUOTATION_LINE, SALES_ORDER, SALES_ORDER_LINE, SALES_BILLING_TABLE, SALES_INVOICE, DELIVERY, DELIVERY_LINE, PRODUCTION_TO_BE_BILLED, PIPELINE_STAGE, SEARCH_PIPELINE_STAGE, QUOTE, QUOTE_LINE, PURCHASE_ORDER, PURCHASE_ORDER_LINE, PURCHASE_BILLING_TABLE, PURCHASE_INVOICE, RECEPTION, TEMPORARY_PURCHASE_INVOICE, SEARCH_OPPORTUNITY, SEARCH_QUOTATION, SEARCH_SALES_ORDER, SEARCH_SALES_BILLING_TABLE, SEARCH_SALES_INVOICE, SEARCH_DELIVERY, SEARCH_PRODUCTION_TO_BE_BILLED_EMPLOYEE, SEARCH_PRODUCTION_TO_BE_BILLED_MANAGER, SEARCH_QUOTE, SEARCH_PURCHASE_ORDER, SEARCH_PURCHASE_BILLING_TABLE, SEARCH_PURCHASE_INVOICE, SEARCH_RECEPTION, SEARCH_TEMPORARY_PURCHASE_INVOICE, SEARCH_SCHEDULE_BY_PROJECT, SEARCH_SCHEDULE_BY_EMPLOYEE, SEARCH_SCHEDULE_TIMESTAMPED, SEARCH_SCHEDULE_WORKLOAD)
3.138. GeneralAccountBase
General account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
3.139. GeneralAccountCommon
General account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
General account label |
|||
number |
General account number |
3.140. GeographicalDepartment
Geographical department
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the geographical department |
|||
companyId |
The id of the company |
|||
id |
Id in database |
|||
name |
Name of the geographical department |
|||
regionId |
The id of the region |
3.141. HistoryEntry
State of a project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Action of the modification |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the modification |
|||
entryType |
Type of the entry |
|||
fieldName |
Name of the modified field |
|||
historyType |
Type of the modified object |
|||
id |
ID of the modification |
|||
objectId |
ID of the modified object |
|||
valueAfter |
Value after the modification |
|||
valueBefore |
Value before the modification |
3.142. HistoryEntryReadOption
ReadOption of a HistoryEntry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the history entry |
Enum: CHANGE_TRACKING |
3.144. HistoryType
Type of the modified object
Type : enum (ISSUE, TASK, OPPORTUNITY, QUOTATION, SALES_ORDER, SALES_INVOICE, SALES_BILLING_TABLE, DELIVERY, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, RECEPTION, CONTACT, EMPLOYEE, EVENT, CUSTOMER, PROJECT)
3.145. Holiday
Holiday
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the holiday |
date-time |
||
type |
Type of holiday |
3.146. IBAN
Details about the IBAN of a people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number - 11 digits max |
|||
country |
Country code of the address in the database |
|||
key |
Key of the IBAN |
3.147. IdIdentifiable
Basic type for all pojos with an API ID
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.148. InternationalBankAccountDetails
International bank account details
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bank |
Details to identify the international bank |
|||
holder |
Holder of the international bank |
3.149. InternationalBankHolder
Holder of the international bank
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountNumber |
Account number |
|||
accountType |
Type of the account for the holder |
|||
firstName |
The first name of the holder |
|||
name |
The name of the holder |
3.150. InternationalBankIdentification
Details to identify the international bank
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bankAddress |
Details about bank address |
|||
bankCode |
The code of the bank |
|||
bankName |
The name of the bank |
|||
bankName2 |
The name 2 of the bank |
|||
bankType |
The type of the bank |
3.151. InventoryAndPackaging
Details about Inventory and Packaging
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
packagingType |
The packaging type of the item |
|||
packagingUnit |
The packaging unit of the item |
double |
3.153. IssueBase
Issue base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.154. IssueCommon
Issue common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the issue. |
|||
title |
The title of the issue. |
3.155. Item
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountSettings |
Accounting information for an item. |
|||
billingMode |
defaut billing mode for the item |
|||
category |
All details about the category of the product |
|||
categoryId |
The Id of the category |
|||
comment |
Comment on the product |
|||
companyCode |
The company code |
|||
customData |
Map of CustomData |
All custom data to update |
||
entityCode |
The entity code |
|||
family (Deprecated) |
The category of the product |
|||
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
inventory |
Returns true if the product is in the inventory |
|||
inventoryAndPackaging |
Details about Inventory and Packaging |
|||
name |
Identification name |
|||
productionEstimatedDuration |
Estimated duration in minutes |
double |
||
quantityPrecision |
Number of decimals for this item quantity |
double |
||
reference |
The reference of the product |
|||
shortName |
Abbreviated designation |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subFamily (Deprecated) |
The sub-category of the product |
|||
unitPricePrecision |
Number of decimals for this item unit price |
double |
3.156. ItemAccountingInfo
Accounting information for an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
disabledDate |
Disabled date of the purchased item. |
date |
||
exportCostAccount |
Number of the export cost account set for purchased item export transactions. |
|||
exportGroupAccount |
Number of the export group account set for purchased item export group transactions. |
|||
intraComCostAccount |
Number of the intra-community cost account set for purchased item intracom transactions. |
|||
intraComGroupAccount |
Number of the intra-community group account set for purchased item intracom group transactions. |
|||
intraComInternalAccount |
Number of intra-community internal account set for purchased item intracom internal transactions. |
|||
intraComSubscriptionAccount |
Number of the intra-community subscription account set for purchased item intracom subscription transactions. |
|||
localCostAccount |
Number of the local cost account set for purchased item local transactions. |
|||
localGroupAccount |
Number of the local group account set for purchased item local group transactions. |
|||
localInternalAccount |
Number of the local internal account set for purchased item local internal transactions. |
|||
localSubscriptionAccount |
Number of the local subscription account set for purchased item local subscription transactions. |
|||
marketEndDate |
End of market of the purchased item. |
date |
||
reverseVAT |
Set the purchased item with reverse VAT liability. |
|||
toBeEstablishedAccount |
To be established account |
|||
vatCode |
X |
Code of the VAT tax rate for the purchased item. |
3.157. ItemBase
Item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.158. ItemCommon
Details about the commons item's properties
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
name |
The name of the product |
|||
reference |
The reference of the product |
3.159. ItemLine
ItemLine
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
discount |
Discount applied |
|||
endDate |
Period end date |
date-time |
||
forcedVat |
Forced VAT for the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
item |
Details about the item |
|||
itemId |
The Id of the product |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
startDate |
Period start date |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
||
vat1 |
Details about the first VAT rate |
|||
vat2 |
Details about the second VAT rate |
|||
vatAmount1 |
Amount expressed in company currency with the first VAT |
double |
||
vatAmount1Currency |
Amount in currency for the first VAT |
double |
||
vatAmount2 |
Amount expressed in company currency for the second VAT |
double |
||
vatAmount2Currency |
Amount in currency for the second VAT |
double |
3.160. JournalEntryNumberingBase
Numbering of the fiscal year journal entries
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fiscalYearId |
Id of the fiscalYear |
|||
id |
Id in database |
|||
prefix |
Prefix of the JournalEntryNumbering |
3.162. LinkDirectionEnum
A filation link type can be set with a link direction
Type : enum (ASCENDING, DESCENDING, TRANSVERSE, NOT_APPLICABLE)
3.163. LinkedObjectType
Type of publish.
Type : enum (CUSTOMER, CONTACT, OPPORTUNITY, EVENT, CARD, ISSUE, EXPENSE, EXPENSE_REPORT, QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, INVOICE, PROJECT, SUPPLIER, DELIVERY, EMPLOYEE, CONTRACT, COMPANY, RECEPTION, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, TRAINING_SESSION, ASSIGNED_TO, OTHER_THIRD_PARTY, PURCHASE_CONTRACT, DISBURSEMENT, PURCHASE_REQUEST, JOURNAL_ENTRY, RECEIPT, REGISTRATION, REGISTRATION_FILE, TASK, PURCHASE_REQUEST_LINE, PHASE, PROJECT_GROUP, MISCELLANEOUS_TRANSACTIONS, PART, SERVICE, PROSPECT, THIRD_PARTY_SITE, CUSTOMER_SITE, SUPPLIER_SITE, INTERNSHIP, PROJECT_TASK, CUSTOM_REQUEST, TEMPORARY_PURCHASE_INVOICE, FIXED_ASSET, SUB_PHASE, CAMPAIGN, DIRECT_DEBIT_MANDATE)
3.164. LocationStatusBase
Basic information for Status of the maintained product.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the locations status. |
|||
id |
Id in database |
|||
name |
Name of the location status. |
3.165. Mail
Represents all information needed to send a mail (recipient, subject and body)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
body |
Content of the mail as a text |
|||
cc |
List of [string] |
Mail carbon copy recipients |
||
cci |
List of [string] |
Mail hidden carbon copy recipients |
||
from |
Mail sender |
|||
replyTo |
Mail reply to |
|||
title |
Mail title |
|||
to |
List of [string] |
Mail recipients |
3.166. ManagementCustomerCriteria
Criteria used on Customer when doing a Customer search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountManagerId |
The ID of the account manager for the customer |
|||
categoryId |
Category of the customer |
|||
code |
Name of the customer |
|||
id |
Ident of the customer |
|||
salesmanId |
The ID of the sales man for the customer |
|||
sectorId |
Sector of the customer |
|||
subCategoryId |
Subcategory of the customer |
|||
type |
Type of the customer (between PROSPECT and CUSTOMER) |
3.167. ManagementObject
Management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountingJournal |
Details of the accounting journal |
|||
accountingJournalId |
ID of Accounting Journal |
|||
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
afterTaxAmountCurrency |
After-Tax amount in the currency |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
assignmentIndicator |
Specifies the type of project and phase: mono project and mono phase, mono project and multi phase, or multi project. |
|||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
conditionOfPayment |
||||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
exchangeRate |
The currency's exchange rate |
double |
||
fiscalYear |
Belonging fiscal year |
|||
fiscalYearId |
Id of the fiscalYear |
|||
group |
Group object |
|||
id |
Id in database |
|||
internal |
Internal object |
|||
manager |
Details of the employee |
|||
managerId |
Id of the manager |
|||
methodOfPayment |
Method of payment |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
payment (Deprecated) |
Deprecated : Use conditionOfPayment instead |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
preTaxAmountCurrency |
Pre-Tax Amount in the currency |
double |
||
pricingMethod |
Details about the pricing method. The method by which pricing is to be determined. |
|||
pricingMethodId |
The id of the pricing method |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
thirdPartyToBillId |
The Id of the third-party to bill |
|||
type |
Example : QUOTATION |
3.168. ManagementObjectBase
Basic information on the management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.169. ManagementObjectBatchResult
Object containing :
- the ids of the successfully treated management objects
- the ids of the management objects with errors
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errors |
List of ErrorMessage |
Contains a list of detailed error messages related to the processing of each identifier. |
||
idsOnError |
List of [string] |
Ids of the management object not processed in batches |
||
idsOnSuccess |
List of [string] |
Ids of the management object processed in batches |
||
managementObjectType |
Type of the management object processed in batches |
3.170. ManagementObjectCommon
Details on common properties of management object (pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax amount expressed in company currency |
double |
||
changeTracking |
||||
companyCode |
The company code |
|||
companyId |
ID of the company |
|||
currency |
Currency used in the management object |
|||
currencyCode |
Code of the currency used in the management object |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
date |
Date on the management object |
date-time |
||
description |
Description |
|||
entityCode (Deprecated) |
The entity code |
|||
id |
Id in database |
|||
name |
Name of the management object |
|||
number |
The number of the management object |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
preTaxAmount |
Pre-Tax Amount expressed in company currency |
double |
||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
thirdPartyId |
The Id of the third-party |
|||
type |
Example : QUOTATION |
3.171. ManagementObjectCriteria
Criteria used to get more details about the management object.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After tax amount of the management object |
|||
approvalDate |
Approval date of the management object |
|||
approvalState |
Approval state of the management object |
|||
companyCode |
Company code of the management object |
|||
creationDate |
Creation date of the management object |
|||
currencyCode |
Currency code of the currency used in the management object |
|||
customData |
Map of Clause |
The custom data (when present) |
||
date |
Date of the management object |
|||
description |
Description of the management object |
|||
entityCode |
Entity code of the management object |
|||
fiscalYearId |
Id of the fiscal year |
|||
group |
True if group |
|||
id |
ID of the management object |
|||
internal |
True if management object is internal |
|||
journalId |
Id of the journal |
|||
managerId |
Id of the manager linked with the management object |
|||
methodOfPayment |
Method of payment of the management object |
|||
name |
Name of the management object |
|||
preTaxAmount |
Pre tax amount of the management object |
|||
thirdPartyId |
Id of the third party |
|||
thirdPartyToBillId |
Id of the third party to bill |
|||
validationDate |
Validation of the management object |
3.172. ManagementObjectLine
Management object line (ligne de pièce de gestion)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE) |
|||
additionalFreeFields |
Additional free fields of a line |
|||
afterTaxAmountTotal |
Total After-Tax amount expressed in company currency |
double |
||
afterTaxAmountTotalCurrency |
Total After-Tax amount in the currency |
double |
||
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
complementName |
Description of the line |
|||
generalAccount |
General Account |
|||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
resource |
Resource allocated to complete the task |
|||
resourceId |
Id of the resource allocated to complete the task |
|||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
totalPrice |
Total price before discount expressed in company currency (unit price * quantity) |
double |
||
totalPriceCurrency |
Total price before discount in the currency (unit price * quantity) |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.173. ManagementObjectLineCommon
Common properties of management object line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
id |
Id in database |
|||
managementObjectId |
Id of the management object |
|||
name |
Name of the line |
|||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the project task of the project |
|||
projectTaskId |
Id of the project task |
|||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
|||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product expressed in company currency. The value in this field is not stored. Upon retrieval, it is calculated based on the rate in effect on the date of the management sales object. |
double |
3.174. ManagementObjectLineCriteria
Criteria used to get more details about the management object line.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
additionalFreeFieldCriteria |
||||
dutiableCriteria |
||||
endDate |
End period clause |
|||
generalAccountNumber |
||||
grouping |
Grouping of the item |
|||
id |
||||
phaseId |
||||
projectCriteria |
Criteria on project linked to the line |
|||
projectId |
||||
reference |
Reference of the item |
|||
resourceId |
Resource allocated to complete the task |
|||
startDate |
Start period clause |
|||
subPhaseId |
3.175. ManagementObjectType
Type of the management object
Type : enum (QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, CUSTOM_REQUEST, PURCHASE_INVOICE, EXPENSE_REPORT, EXPENSE, INVOICE, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, RECEPTION, DELIVERY, PRODUCTION)
3.176. ManagementProjectCriteria
Criteria used on Project when doing a Project search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activityId |
||||
categoryId |
||||
companyId |
The Id of the company |
|||
customerId |
||||
customerProjectId |
Ident of the project (equivalent to the code of the project) |
|||
departmentId |
||||
divisionGroupingId |
||||
divisionId |
||||
entityId |
||||
financialManagerId |
||||
id |
||||
managerId |
||||
name |
||||
productionManagerId |
||||
projectGroupCode |
||||
projectState |
||||
referentialDate |
Date à laquelle l'affaire doit être active (en prod) |
date-time |
||
salesManagerId |
||||
subCategoryId |
||||
subCategoryLevel2Id |
||||
tag |
Unused at the moment |
|||
yearId |
Ident of the year |
3.177. ManagerVisibilityCriteria
Manager's criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
includeManager |
Include manager in the search result |
|||
includeResourcesTwoManagementLevelsBelow |
Include resources from two management levels below (N-2) in the search result |
|||
managerId |
Id of the manager |
3.178. Message
A message is a combination of a Mail (used to store standard information for sending a mail) and functional information. This functional information is processed by backend service to compute standard information for sending mail like an employee's email address.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
attachFile |
Location of the file to be attached. |
|||
ccRecipients |
List of MessageRecipient |
List of recipients to be included in CC (carbon copy). |
||
cciRecipients |
List of MessageRecipient |
List of recipients to be included in BCC (blind carbon copy - CCI). |
||
All details required to send an email (recipients, subject, body). |
||||
publishedDocuments |
List of PublishedDocument |
List of documents to be published as attached files. |
||
replyTo |
Mail recipient for reply-to. |
|||
toRecipients |
List of MessageRecipient |
List of primary recipients. |
3.179. MessageRecipient
Recipient of a message
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
address |
The email address of the recipient. |
|||
id |
Id in database |
|||
summary |
A brief summary or description of the recipient. |
|||
type |
Type of message recipient. |
3.180. MessageRecipientType
Message recipient type
Type : enum (USER, EMPLOYEE, CONTACT, TEAM, MAIL_ADDRESS)
3.181. MethodOfPayment
Method of payment
Type : enum (CREDIT_CARD, CHECK, CASH, CHECK_LETTER, DIRECT_DEBIT, INTER_BANK_PAYMENT_DOCUMENT, BANK_DRAFT, BANK_TRANSFER, BANK_TRANSFER_CURRENCY, OTHER)
3.182. MobAction
Action
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the action |
|||
ident |
ID of the action |
double |
||
name |
Name of the action |
|||
regroup |
Regroup of the action |
3.183. MobAction2
Action 2
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the action |
|||
ident |
ID of the action |
double |
||
name |
Name of the action |
3.184. MobActionCriteria
Criteria used on Action Code when doing an Action Code search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
name |
||||
tag |
You can use this clause to do a text search on the code and name |
|||
validity |
3.185. MobActiviteParDefaut
Activite Par defaut
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
||||
action2 |
||||
assignment |
Assignment |
|||
comment |
Comment of the default activity |
|||
customerId |
ID of the customer |
double |
||
description |
Description of the default activity |
|||
duration |
Duration of the default activity |
double |
||
errors |
||||
guid |
GUID (obsolete) |
|||
id |
ID of the default activity |
|||
location |
Location of the default activity |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.186. MobAffectation
Affectation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
assignments |
List of MobAffectation |
List of mob affectations |
||
code |
Code of the mob affectation |
|||
customerId |
ID of the customer of the mob affectation |
|||
description |
Description of the mob affectation |
|||
id |
ID of the mob affectation |
|||
longDescription |
Long description of the mob affectation |
|||
modules |
Name of the modules of the mob affectation |
|||
params |
List of MobAffectationParam |
Params for the mob affectation |
||
parent |
The parent mob affectation |
|||
parentType |
Parent type of the mob affectation |
|||
parent_id |
Parent ID of the mob affectation |
|||
type |
Type of the mob affectation |
3.187. MobAffectationParam
Parameters of Affectation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
type |
The mob affectation param type |
|||
value |
The mob affectation param value |
3.188. MobAffectationParamType
Type of parameter of Affectation
Type : enum (ACTION_CODES_AUTHORIZED, DUMMY)
3.189. MobApprovalState
State of the Approval
Type : enum (NONE, TO_REQUEST, TO_APPROVE, REFUSED, APPROVED)
3.190. MobCalendarEvent
Calendar Event
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
||||
assignment |
Assignment |
|||
commentaire |
Comment of the calendar event |
|||
customerId |
ID of the customer |
double |
||
datCre |
Creation date of the calendar event |
date-time |
||
date |
Date of the calendar event |
date-time |
||
duration |
Warning:/ if this field is null, the duration will be set to 0. |
double |
||
errors |
||||
eventState |
Example : BRUT |
|||
guid |
GUID (obsolete) |
|||
ident |
ID of the calendar event |
double |
||
lieu |
Location of the calendar event |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
readOnly |
True if calendar event is read only |
|||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
taskId |
Task ID of the calendar event |
double |
||
typeEvent |
The type of the calendar event |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.191. MobCalendarEventRules
Basic type calendar event rules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowManualEntry |
Autorise ou non pas la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée |
|||
base |
Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) |
double |
||
canModify |
L'utilisateur a le droit de modification |
|||
canRead |
L'utilisateur a le droit de consultation |
|||
closingDates |
List of MobClosingDate |
Dates d'arrêté pour le temp et les plannings |
||
max |
Borne maximale exclue de saisie d'une durée |
double |
||
min |
Borne minimale exclue de saisie d'une durée |
double |
||
prettyStep |
Pas d'incrémentation graphique d'une durée |
double |
||
situations |
List of MobSituation |
Situations du collaborateurs dans son propre mode de saisie |
||
step |
Précision d'une durée, utile pour connaître le pas d'incrémentation |
double |
||
taskMandatory |
Rend la sélection d'une tâche obligatoire |
|||
unit |
Code de l'unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation) |
3.193. MobCalendarEvents
Calendar Events
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
schedules |
List of MobSchedule |
List of schedules |
||
timesheetEntries |
List of MobTimesheetEntry |
List of timesheet entries |
3.194. MobCategorieDepense
Category of expense type
Type : enum (REGULAR, MILEAGE, TOLL, RESTAURANT_DOUBLE_VAT)
3.195. MobClosingDate
Closing Date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
beginningOfPeriod |
Start of closing |
date-time |
||
closingDate |
Date of closing |
date-time |
||
endOfPeriod |
End of closing |
date-time |
||
module |
Module concerned |
3.196. MobCollaborateur
Collaborateur
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the employee |
|||
company |
Company code of the employee |
|||
firstName |
First name of the employee |
|||
ident |
ID of the employee |
double |
||
lastName |
Last name of the employee |
3.197. MobCollaborateurCriteria
Criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the employee |
date-time |
||
tag |
3.198. MobCommand
Command
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
Data of the command |
|||
date |
Date of the command |
date-time |
||
errors |
||||
guid |
GUID (obsolete) |
|||
hasBeenProcessed |
True if the command has been processed |
|||
ident |
ID of the command |
double |
||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
state |
Example : SYNC |
|||
type |
Example : TIME_RECORDING_TERMINATION |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.199. MobCommandType
Command Type
Type : enum (TIME_RECORDING_TERMINATION, TIME_RECORDING_TERMINATION_CANCEL, EXPENSE_REPORT_TERMINATION, EXPENSE_REPORT_TERMINATION_CANCEL)
3.201. MobCustomRequest
Custom request
If the custom request project is null, this means the custom request is multi project.
In this case, each custom request line can be linked to a different project.
On the other hand, if the custom request project is not null, the custom request is mono project,
and in this case, all the custom request lines are linked to the same project.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-Tax Amount |
double |
||
approvalDate |
Date of approval |
date-time |
||
approvalState |
State of approval |
|||
archiveDate |
Archive date |
date-time |
||
archiveUserId |
Archive user |
|||
arrivalActualDate |
Actual arrival date |
date-time |
||
arrivalCity |
Arrival city |
|||
arrivalDate |
Arrival date |
date-time |
||
arrivalLocation |
Arrival location |
|||
assignment |
Assignment |
|||
cancellationDate |
Cancellation date |
date-time |
||
cancellationUser |
User who made the cancellation |
|||
cancellationUserId |
Cancellation user |
|||
category |
Category of the custom request |
|||
categoryId |
Id of the category |
|||
currency |
Currency of the custom request |
|||
customData |
Map of CustomData |
The custom data (when present) |
||
customerId |
ID of the customer |
double |
||
date |
Date on the custom request |
date-time |
||
departureActualDate |
Actual departure date |
date-time |
||
departureCity |
Departure city |
|||
departureDate |
Departure date |
date-time |
||
departureLocation |
Departure location |
|||
description |
Description |
|||
documents |
List of MobDocument |
Details about documents linked to the custom request |
||
documentsToDelete |
List of MobDocument |
Documents to remove from the custom request |
||
employeeId |
Id of the employee |
|||
errors |
||||
guid |
GUID (obsolete) |
|||
id |
Id of the custom request |
|||
lines |
List of MobCustomRequestLine |
List of the custom request's lines with their details |
||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
name |
Name of the custom request |
|||
number |
The number of the custom request |
|||
numberOfDocuments |
Number of documents linked to the expense |
|||
phaseId |
ID of the phase |
double |
||
preTaxAmount |
Pre-Tax Amount |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.202. MobCustomRequestCategory
Custom request category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code given to the custom request category |
|||
companyId |
Id of the company |
|||
customDataEnd |
End index of custom data to display |
double |
||
customDataNbColumns |
Nb columns to dispatch custom data |
double |
||
customDataStart |
Start index of custom data to display |
double |
||
defaultValueWithoutExpense |
True to setup the category without expenses as default value |
|||
departureLocation |
Enable departure location |
|||
departureLocationType |
Type of departure location |
|||
destinationLocation |
Enable destination location |
|||
destinationLocationType |
Type of destination location |
|||
displayCustomData |
Display custom data |
|||
editableWithoutExpense |
True to allow edit mode on adding expenses to the custom request |
|||
enableActualDates |
Enable actual dates |
|||
enableEndDate |
Enable end date |
|||
endDate |
The validity end date of the custom request category |
date-time |
||
icon |
The icon representing the category |
|||
id |
Id in database |
|||
name |
The name of the custom request category |
|||
scheduleCreation |
Enable creation on a schedule |
|||
timesheetCreation |
Enable creation on a timesheet entry |
3.203. MobCustomRequestLine
Custom request line
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountTotal |
Total amount expressed in company currency |
double |
||
amountTotalCurrency |
Total amount in the currency |
double |
||
assignment |
Assignment |
|||
customerId |
ID of the customer |
double |
||
errors |
||||
expenseTypeExpected |
Details about the expected expense type |
|||
expenseTypeExpectedId |
Id of the expected expense type |
|||
guid |
GUID (obsolete) |
|||
id |
Id of the custom request line |
|||
isExpenseReport |
Return true if the custom request line is linked to an expense report |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
name |
Name of the line |
|||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
quantity |
Quantity of the product |
double |
||
rankNumber |
Rank number of the line |
double |
||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
unitPrice |
Unit price of the product expressed in company currency |
double |
||
unitPriceCurrency |
Unit price of the product in the currency |
double |
||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.204. MobCustomRequestLocationParamHolder
Parameters used when doing a search on custom request locations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
customerIds |
List of [string] |
Id(s) of the customer(s) linked to the custom request |
||
searchText |
You can fill in the code or name of the tag in this field |
|||
type |
Example : DEPARTURE |
3.206. MobCustomerCriteria
Criteria used on Customer when doing a Customer search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
Module actif depuis lequel est appelée la recherche |
|||
filterOnLinkProjectCustomer |
Permet d'appliquer le filtre d'affaire sur le lien Affaire Client |
|||
id |
Ident of the customer |
|||
projectId |
Ident of the project |
|||
referentialDate |
Date à laquelle le client doit être actif (ouvert et non clôturé) |
date-time |
||
tag |
You can use this clause to do a text search on the code and call name |
3.207. MobDepartureLocationType
Type of departure location
Type : enum (ENTITIES, DOMICILE, UNRESTRICTED_INPUT)
3.208. MobDestinationLocationType
Type of destination location
Type : enum (CUSTOMER_SITES, CITIES, UNRESTRICTED_INPUT)
3.209. MobDevise
Devise
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the mob devise |
|||
endDate |
End date of the mob devise |
date-time |
||
euro |
True if mob devise is euro |
|||
euroRate |
Euro rate of the mob devise |
double |
||
ident |
ID of the mob devise |
double |
||
order |
Order of the mob devise |
double |
3.210. MobDistanceParameters
Distance parameters between origin and destination addresses
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
avoidHighways |
Avoid highways |
|||
avoidTolls |
Avoid tolls |
|||
destination |
Location to use as the finishing point for calculating travel distance. The options for the destination parameter are the same as for the origins parameter. |
|||
destinationId |
Destination's ID |
|||
origin |
The starting point for calculating travel distance. You can supply one location in the form of an address. |
|||
originId |
Origin's ID |
3.211. MobDocument
Document
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
createDate |
Creation date of the document |
date-time |
||
deleted |
True if document has been deleted |
|||
fileUrl |
File url of the document |
|||
guid |
GUID of the document |
|||
ident |
ID of the document |
double |
||
identVersion |
Version ID of the document |
double |
||
internal_ident |
Internal ID of the document |
|||
sysName |
Sys name of the document |
|||
title |
Title of the document |
|||
token |
Token of uploaded file for creation only |
|||
version |
Version of the document |
double |
3.212. MobEventLocation
Event location
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
description |
Event location description |
|||
id |
Id in database |
|||
value |
Event location value |
3.213. MobExpenseTypeExpected
Expected expense type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the expected expense type |
|||
defaultExpenseReport |
Whether or not the custom request line will be an expense report by default |
|||
description |
Description of the expected expense type |
|||
editableExpenseReport |
Whether or not we can choose to transform the custom request line into an expense report |
|||
endDate |
End date for using the expected expense type |
date-time |
||
expenseType |
Expense type |
|||
id |
Id in database |
|||
name |
Name of the expected expense type |
3.214. MobExpenseWithVehicleParamHolder
Param holder for expense with vehicle
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
completed |
Return true if the expense report is completed |
|||
employeeId |
Ident of the employee |
|||
expenseDate |
Date of the expense |
date-time |
||
expenseId |
Ident of the expense |
|||
expenseReportId |
Ident of the expense report |
double |
||
expenseTypeId |
Ident of the expense type |
|||
kilometersEnteredOnCurrentExpense |
Number of kilometers driven |
double |
||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
double |
3.215. MobFormConfig
Form Config
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controlsBehavior |
List of ControlBehavior |
Field control behavior (new way) |
||
fields |
List of MobFormFieldConfig |
Field control behavior (old way) |
||
name |
Name of the form config |
|||
zones |
List of MobFormZoneConfig |
List of form zone configs |
3.216. MobFormFieldConfig
Form Field Config
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
Map of [object] |
Data of the form field config |
||
name |
Name of the form field config |
3.217. MobFormZoneConfig
Form Zone Config
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
data |
Map of [object] |
Data of the form zone config |
||
name |
Name of the form zone config |
3.218. MobHasAssignement
Has Assignement
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
assignment |
Assignment |
|||
customerId |
ID of the customer |
double |
||
errors |
||||
guid |
GUID (obsolete) |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.219. MobHoliday
Holiday
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of the holiday |
date-time |
||
type |
Type of holiday |
3.220. MobInvite
Invite
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
codeEmployee |
Code of the employee |
|||
company |
Company of the guest |
|||
firstName |
First name of the guest |
|||
ident |
ID of the guest |
double |
||
identEmployee |
ID of the employee |
double |
||
lastName |
Last name of the guest |
3.221. MobKeywordValue
Keyword value
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the keyword |
|||
name |
Name of the keyword |
3.222. MobKilometerCompensation
Param holder for amounts of kilometers compensation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountCalculated |
Amount calculated |
double |
||
amountDue |
Amount due |
double |
||
amountRefunded |
Amount already refunded |
double |
||
kmTotal |
Number of kilometers driven |
double |
3.223. MobLeave
Leave
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
comment |
Comment of the leave |
|||
commentValidator |
The comment of the validator on the leave |
|||
dateValidator |
Validation date of the leave |
date-time |
||
duration |
Duration of the leave |
double |
||
employeeValidator |
Validator employee of the leave |
|||
endDate |
End date of the leave |
date-time |
||
errors |
||||
guid |
GUID (obsolete) |
|||
id |
ID of the leave |
|||
leaveRightId |
ID of the leave right |
|||
leaveState |
Example : ACCEPTED |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
requestDate |
Request date of the leave |
date-time |
||
startAfterNoon |
True if the leave starts in the afternoon |
|||
startDate |
Start date of the leave |
date-time |
||
state |
Example : SYNC |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.224. MobLeaveDuration
Duration of leave according some properties
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
duration |
Duration in days |
double |
||
end |
End of leave |
date-time |
||
estimatedRightAtStart |
Estimated rights at start date |
double |
||
start |
Start of leave |
date-time |
||
startAfterNoon |
True if the leave starts in the afternoon |
3.225. MobLeaveRight
Leave Right
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
acquisitionEndDate |
Acquisition end date of the leave right |
date-time |
||
acquisitionStartDate |
Acquisition start date of the leave right |
date-time |
||
adjustment |
Adjustment of the leave right |
double |
||
comment |
Comment of the leave right |
|||
employeeId |
ID of the employee |
|||
endDate |
End date of the leave right |
date-time |
||
entry |
Entry of the leave type |
|||
estimatedMaxRight |
The estimated right at the acquisition end date |
double |
||
id |
Id in database |
|||
incremental |
True if the right is incremental |
|||
name |
Name of the leave right |
|||
right |
Right associated with the leave right |
double |
||
startDate |
Start date of the leave right |
date-time |
||
tolerance |
Tolerance of the leave right |
double |
3.228. MobLigneNdf
Ligne Ndf
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmountRefunded |
After tax amount refunded of the expense line |
double |
||
afterTaxCurrencyAmountRefunded |
After tax currency amount refunded of the expense line |
double |
||
amount |
Amount of the expense line |
double |
||
amountCalculated |
Amount calculated |
double |
||
amountCategory |
Amount Category (Unitary/Total) |
|||
amountCurrency |
Amount currency of the expense line |
double |
||
amountDue |
Amount due |
double |
||
amountRefunded |
Amount already refunded |
double |
||
amountWithoutVat |
Amount exempt from VAT |
double |
||
arrivalLocation |
Location of departure |
|||
assignment |
Assignment |
|||
businessCard |
True if business card has been used |
|||
complementName |
Extension of the expense line title |
|||
currency |
Currency of the expense line |
|||
customerId |
ID of the customer |
double |
||
datCre |
Creation date of the expense line |
date-time |
||
dateOfDenial |
Date of denial of the expense line |
date-time |
||
departureLocation |
Location of departure |
|||
documents |
List of MobDocument |
List of the expense line documents |
||
documentsToDelete |
List of MobDocument |
List of the expense line documents to delete |
||
engineTaxRate |
||||
errors |
||||
expenseDate |
Date of the expense |
date-time |
||
finished |
True if the expense line is finished |
|||
guests |
List of MobInvite |
List of the expense line guests |
||
guid |
GUID (obsolete) |
|||
hasDocuments |
True if the expense line has documents |
|||
ident |
ID of the expense line |
double |
||
identExpReport |
ID of the expense report |
double |
||
isDuplicateExpenseForSameEmployee |
This field is set on true if the expense is a duplicate expense for the same employee. |
|||
isDuplicateExpenseForSeveralEmployee |
This field is set to true if the expense is a duplicate expense for several employees. |
|||
isExpenseOnEmployeeLeaveDay |
This field is set to true if the expense is entered on a day the employee is absent. |
|||
isExpenseOnEmployeeNonWorkingDay |
This field is set to true if the expense is entered on an employee's non-working day. |
|||
kilometer |
Number of kilometers of the expense line |
double |
||
kmTotal |
Total of kilometers driven |
double |
||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
notRefundable |
True if expense line is not refundable |
|||
parts |
Number of parts |
double |
||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
quantity |
Quantity of the expense line |
double |
||
rebillable |
True if expense line is rebillable |
|||
receiptNb |
Receipt number of the expense line |
|||
refusalComment |
Refusal comment of the expense line |
|||
refusingEmployee |
||||
smartScan |
True if is smart scan |
|||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
title |
Title of the expense line |
|||
type |
||||
unitPrice |
Unit price of the expense line |
double |
||
unitPriceCurrency |
Unit price currency of the expense line |
double |
||
updateDate |
Last time update in BDD (obsolete) |
date-time |
||
validated |
True if the expense line is validated |
|||
vat1 |
||||
vat2 |
||||
vat3 |
||||
vatAmount1 |
First vat amount |
double |
||
vatAmount2 |
Second vat amount |
double |
||
vatAmount3 |
Third vat amount |
double |
||
vehicle |
Details about vehicle |
3.229. MobLocale
Locale
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
country |
Code of the region / country |
|||
internalLocale |
Identifiers for language and region |
|||
label |
Label of the locale |
|||
labelInLocale |
Label in the locale |
|||
language |
Code of the language |
|||
locale |
Identifiers for language and region |
|||
variant |
Variant of the locale |
3.230. MobNatureDepense
Nature Depense
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
amountDft |
The amountDft of the expense nature |
double |
||
amountEditable |
True if the amount is editable |
|||
billableEditable |
True if billable is editable |
|||
canEditCurrencyVATIncl |
True if can use VAT incl |
|||
canUseAdditionalComment |
True if can use comment |
|||
canUseAmountWithoutVat |
Return true if phone display the amount without VAT |
|||
canUseDoubleVAT |
True if can use vat |
|||
canUseInvitation |
True if can use invitation |
|||
canUseKm |
True if can use km |
|||
canUseNotRefundable |
True if can use not refundable |
|||
canUseQuantity |
True if can use quantity |
|||
canUseReceiptNumber |
True if can use receipt number |
|||
code |
Code of the expense nature |
|||
color |
The color of the expense nature |
|||
commentRequired |
True if the comment is required |
|||
controlsBehavior |
List of ControlBehavior |
Field control behavior for expense Type |
||
description |
Description of the expense nature |
|||
endDate |
The end date of the expense nature |
date-time |
||
expenseCategory |
The expense category |
|||
expenseThresholdExceededNoVat |
No VAT if exceeded threshold. If true, VAT is disabled and reset to 0 on the expense when the amount is over the threshold. |
|||
hideVat |
True if vat is hidden |
|||
icon |
The icon of the expense nature |
|||
ident |
ID of the expense nature |
double |
||
limit |
Limit of the expense nature |
double |
||
notRefundableEditable |
True if not refundable is editable |
|||
receiptRequired |
True if the receipt is required |
|||
type |
Type of the expense nature |
|||
vat |
||||
vat2 |
||||
vat3 |
3.231. MobNdf
Ndf
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
currencyCode |
Currency code used in the expense |
|||
datCre |
Creation date of the expense |
date-time |
||
date |
Date of the expense |
date-time |
||
description |
Description of the expense |
|||
expenses |
List of MobLigneNdf |
List of expense lines |
||
finished |
True if the expense is finished |
|||
guid |
GUID associated with the expense |
|||
ident |
ID of the expense |
double |
||
validated |
True if the expense is validated |
|||
vatInclAmount |
VAT incl amount of the expense |
double |
3.232. MobOnBoardingNews
On boarding News
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
detail |
Summary of the news |
|||
helpLink |
Link to the web help |
|||
title |
Title of the news |
3.233. MobParametrage
Parametrage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actions |
List of MobAction |
List of mob actions |
||
actions2 |
List of MobAction2 |
List of mob actions |
||
assignments |
List of MobAffectation |
List of mob affectations |
||
currencies |
List of MobDevise |
List of mob devises |
||
customRequestCategories |
List of MobCustomRequestCategory |
List of custom request categories |
||
employees |
List of MobCollaborateur |
List of mob collabs |
||
errors |
List of [string] |
List of errors |
||
expenseTypes |
List of MobNatureDepense |
List of mob nature depense |
||
expenseTypesExpected |
List of MobExpenseTypeExpected |
Expense type expected available |
||
formConfigs |
List of MobFormConfig |
List of mob form configs |
||
hash |
The param hash |
|||
holidays |
List of MobHoliday |
List of mob holidays |
||
locales |
List of MobLocale |
List of idenfifiers with the language and region |
||
powers |
List of MobPuissance |
List of mob puissance objects |
||
scheduleRules |
The schedule rules of the param |
|||
timesheetEntryRules |
The timesheet entry rules of the param |
|||
vats |
List of MobTva |
List of vat numbers |
3.234. MobParametrageAction
Parametrage Action
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action of the mob parametrage action |
|||
type |
The type of mob parametrage action |
|||
value |
The value of the mob parametrage action |
3.235. MobPlaceSearchResult
Place search result
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
address |
Place's address |
|||
id |
Place's ID |
|||
name |
Place's name |
3.236. MobPuissance
Puissance
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the mob puissance |
|||
endDate |
End date of the mob puissance |
date-time |
||
expenceTypeCode |
Code of the expense type of the mob puissance |
|||
expenseTypeId |
ID of the expense type of the mob puissance |
double |
||
ident |
ID of the mob puissance |
double |
||
power |
Power of the mob puissance |
|||
price |
Price of the mob puissance |
double |
||
startDate |
Start date of the mob puissance |
date-time |
3.237. MobRecurringRemoteWork
Declaration of recurring remote work
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endDate |
End date of the recurring remote work declaration (hours ignored) |
date-time |
||
friday |
||||
monday |
||||
saturday |
||||
startDate |
Start date of the recurring remote work declaration (hours ignored) |
date-time |
||
sunday |
||||
thursday |
||||
tuesday |
||||
wednesday |
3.238. MobRecurringRemoteWorkDay
Remote work entry of an Employee at a date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afternoon |
Remote work the afternoon |
|||
morning |
Remote work the morning |
3.239. MobRemoteWorkEntry
Remote work entry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afternoon |
True if remote work in the afternoon |
|||
date |
Date of the entry |
date-time |
||
id |
ID of the entry |
|||
morning |
True if remote work in the morning |
3.240. MobSchedule
Schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
||||
assignment |
Assignment |
|||
color |
Color of the schedule (hexadecimal code) |
|||
commentaire |
Comment of the calendar event |
|||
customerId |
ID of the customer |
double |
||
datCre |
Creation date of the calendar event |
date-time |
||
date |
Date of the calendar event |
date-time |
||
dayMode |
True when the schedule is in day mode (1 day, half day…) |
|||
dayPart |
Part of the day. Only works if control PLG_HORODATE is not active |
double |
||
descriptive |
Description of the schedule |
|||
duration |
Warning:/ if this field is null, the duration will be set to 0. |
double |
||
endDate |
End date of the schedule |
date-time |
||
errors |
||||
eventState |
Example : BRUT |
|||
guid |
GUID (obsolete) |
|||
ident |
ID of the calendar event |
double |
||
leave |
True if schedule is marked as 'leaved' |
|||
lieu |
Location of the calendar event |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
onlineMeeting |
True if it is an online meeting |
|||
phaseId |
ID of the phase |
double |
||
planningAction |
Example : TRANSFERT_TEMPS |
|||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
readOnly |
True if calendar event is read only |
|||
siteId |
ID of the site |
|||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
taskId |
Task ID of the calendar event |
double |
||
typeEvent |
The type of the calendar event |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
||
validated |
True if schedule is validated |
3.242. MobScheduleFillOptions
Options needed to fill the schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
endMoment |
Example : MORNING |
|||
startMoment |
Example : MORNING |
3.243. MobScheduleFillParamHolder
Object containing the schedule to fill and the options needed to fill the schedule
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
Details about schedule's fill options |
|||
schedule |
Details about schedule |
3.244. MobScheduleRules
Schedule Rules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowManualEntry |
Autorise ou non pas la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée |
|||
base |
Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) |
double |
||
canModify |
L'utilisateur a le droit de modification |
|||
canModifyValidated |
True if can modify validated schedule rules |
|||
canRead |
L'utilisateur a le droit de consultation |
|||
canTransferInTimesheetEntries |
Can transfer schedule in timesheet entry |
|||
closingDates |
List of MobClosingDate |
Dates d'arrêté pour le temp et les plannings |
||
max |
Borne maximale exclue de saisie d'une durée |
double |
||
min |
Borne minimale exclue de saisie d'une durée |
double |
||
prettyStep |
Pas d'incrémentation graphique d'une durée |
double |
||
situations |
List of MobSituation |
Situations du collaborateurs dans son propre mode de saisie |
||
step |
Précision d'une durée, utile pour connaître le pas d'incrémentation |
double |
||
taskMandatory |
Rend la sélection d'une tâche obligatoire |
|||
timestamped |
True if timestamp present |
|||
unit |
Code de l'unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation) |
3.245. MobSituation
Situation
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
averageDayDuration |
Average duration of a day |
double |
||
dayDuration |
Duration of a day |
double |
||
durationsByWeekDayNumber |
Map of [double] |
Standard week |
double |
|
from |
Start of the employee history |
date-time |
||
to |
End of the employee history |
date-time |
||
typicalDaysByWeekDayNumber |
Map of MobTypicalDay |
Standard week |
3.246. MobSyncErrors
Sync Errors
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errors |
List of [string] |
List of sync errors |
3.247. MobSynchronizedBean
Synchronized Bean
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errors |
||||
guid |
GUID (obsolete) |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
state |
Example : SYNC |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.248. MobTimesheetEntry
Timesheet entry
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
||||
action2 |
||||
assignment |
Assignment |
|||
commentaire |
Comment of the calendar event |
|||
completionDate |
Completion date of the timesheet entry |
date-time |
||
customerId |
ID of the customer |
double |
||
datCre |
Creation date of the calendar event |
date-time |
||
date |
Date of the calendar event |
date-time |
||
duration |
Warning:/ if this field is null, the duration will be set to 0. |
double |
||
errors |
||||
eventState |
Example : BRUT |
|||
guid |
GUID (obsolete) |
|||
ident |
ID of the calendar event |
double |
||
lieu |
Location of the calendar event |
|||
mobileUpdateDate |
Last time update in mobile (obsolete) |
date-time |
||
phaseId |
ID of the phase |
double |
||
projectId |
ID of the project |
|||
projectTaskId |
ID of the project task |
double |
||
readOnly |
True if calendar event is read only |
|||
state |
Example : SYNC |
|||
subPhaseId |
ID of the sub-phase |
double |
||
taskId |
Task ID of the calendar event |
double |
||
typeEvent |
The type of the calendar event |
|||
updateDate |
Last time update in BDD (obsolete) |
date-time |
3.249. MobTimesheetEntryCompletion
TimesheetEntryCompletion
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
completionType |
Type of the completion |
Enum: WEEK, MONTH, WEEK, MONTH |
||
date |
Date of the completion |
date-time |
||
id |
ID of the completion |
3.250. MobTimesheetEntryRules
Timesheet entry rules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCodesExcludedFromStep |
List of [string] |
List of action code |
||
allowManualEntry |
Autorise ou non pas la saisie manuelle de la durée, si non, seule la saisie via le range de valeurs sera autorisée |
|||
base |
Base de calcul permettant de déduire la valeur max de décimal autorisé (ex: 60, 100) |
double |
||
canModify |
L'utilisateur a le droit de modification |
|||
canRead |
L'utilisateur a le droit de consultation |
|||
closingDates |
List of MobClosingDate |
Dates d'arrêté pour le temp et les plannings |
||
completionType |
Example : WEEK |
|||
max |
Borne maximale exclue de saisie d'une durée |
double |
||
min |
Borne minimale exclue de saisie d'une durée |
double |
||
prettyStep |
Pas d'incrémentation graphique d'une durée |
double |
||
situations |
List of MobSituation |
Situations du collaborateurs dans son propre mode de saisie |
||
step |
Précision d'une durée, utile pour connaître le pas d'incrémentation |
double |
||
taskMandatory |
Rend la sélection d'une tâche obligatoire |
|||
unit |
Code de l'unité de présentation (cf com.itnsa.fwk.util.temps.UniteDePresentation) |
3.251. MobTva
Tva
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the mob tva |
|||
description |
Description of the mob tva |
|||
ident |
ID of the mob tva |
double |
||
key |
Key of the mob tva |
|||
rate |
Rate of the mob tva |
double |
3.253. MobTypicalDay
Typical Day
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
nbHoursWorkingAfternoon |
Number of hours worked in the afternoon for a typical day |
double |
||
nbHoursWorkingMorning |
Number of hours worked in the morning for a typical day |
double |
3.254. MobUpdateParametrage
Update Parametrage
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actions |
List of MobParametrageAction |
List of mob parametrage actions |
3.255. MobVehicle
Vehicle of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employee |
Details about the employee |
|||
endDate |
Date by which the vehicle ends |
date-time |
||
expenseType |
Details about the expense type |
|||
id |
Id in database |
|||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
double |
3.256. MobVehicleCriteria
Search criteria for vehicle
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
employeeId |
Ident of the employee |
|||
expenseTypeId |
Ident of the expense type |
|||
id |
Ident of the vehicle |
|||
licensePlate |
License Plate of the vehicle |
|||
power |
Power of the engine |
|||
validity |
Details about the validity criteria |
3.257. NoneSEPA
International bank detail
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
beneficiary |
Details of the beneficiary's international bank account, including identification and account holder information. |
|||
defaultBankDetail |
Set as true if this international bank detail will be used by default. |
|||
intermediate |
Details of the intermediate's international bank account, including identification and account holder information. |
3.258. ObjectHistoryLink
A link between a target object and other objects
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
objectId |
Id of the object linked to a target object |
|||
objectType |
Example : CUSTOMER |
|||
targetId |
Id of target object |
3.259. OpportunityBase
OpportunityBase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the opportunity. |
|||
id |
Id in database |
|||
name |
The name of the opportunity. |
3.260. OtherThirdPartieBase
Other Third Partie Base (Autre Tiers)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.261. OtherThirdPartyTypeBase
Type of Other Third-Party
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
X |
The code of the other third-party type |
||
id |
Id in database |
|||
name |
X |
The name of the other third-party type |
3.262. ParametrageHash
Parametrage Hash
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activiteHash |
The activite hash of the parametrage hash |
|||
collaborateursHash |
The collaborateur hash of the parametrage hash |
|||
natureHash |
The nature hash of the parametrage hash |
3.263. PatchElement
A JSONPatch as defined by RFC 6902
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
from |
X |
A JSON-Pointer @see https://tools.ietf.org/html/rfc6901 |
||
op |
X |
The operation to be performed |
Enum: ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND, ADD, REMOVE, REPLACE, TEST, MOVE, COPY, AK_APPEND |
|
path |
X |
A JSON-Pointer @see https://tools.ietf.org/html/rfc6901 |
||
value |
The value to be used within the operations. |
3.264. PatchHolder
List of patches to apply to the idents specified
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
ids |
List of [string] |
Idents to patch |
||
patchElements |
List of PatchElement |
List of patches to apply |
3.265. Payment
Payment
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Payment code |
|||
day |
Day of the month on which the payment will be done |
double |
||
deadLine |
Number of days to carry out the payment |
|||
term |
Period of payment |
3.266. PeopleLink
People Link
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultLink |
Determine the default people link used in the case. 'True' if the people link is the one to apply by default |
|||
id |
Id in database |
|||
linkSource |
Detail about the people link relationship between the path third party and another third party. |
|||
linkSourceId |
Id of the type of people link for the source third party. |
|||
linkTarget |
Detail about the people linkTarget relationship between the path third party and another third party. |
|||
linkTargetId |
Id of the type of people link for the target third party. |
|||
linkType |
A link can be set as a Management Link or a Filiation Link. |
|||
sourceThirdParty |
Detail about the third party. |
|||
sourceThirdPartyId |
Id of the source third party. |
|||
sourceThirdPartyType |
Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
|||
targetThirdParty |
Detail about the third party |
|||
targetThirdPartyId |
Id of target third party to link. |
|||
targetThirdPartyType |
Type of the target third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
3.267. PeopleLinkCriteria
Criteria used on People Link when doing a People Link search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
defaultLink |
If true, the people link is the one set by default on the third party with the link |
|||
id |
||||
linkSourceId |
Id of the people link relationship between the path third party and another third party |
|||
linkTargetId |
Id of the people link relationship between a third party and the path third party |
|||
linkType |
A link can be set as a Management Link or a Filiation Link |
|||
readOption |
Options for retrieving extra information concerning the peopleLink |
|||
sourceThirdPartyId |
Id of the third party linked |
|||
sourceThirdPartyType |
Type of the source third party linked (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
|||
targetThirdPartyId |
Id of the target third party with people links |
|||
targetThirdPartyType |
Type of the third party with people links (PROSPECT, CUSTOMER, SUPPLIER OR OTHER_THIRD_PARTY) |
3.268. PeopleLinkReadOption
Options used to get additional information when doing a peopleLink's search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the people link |
Enum: LINK_SOURCE, LINK_TARGET, SOURCE_THIRD_PARTY, TARGET_THIRD_PARTY |
3.269. PeopleLinkType
People Link Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code for the type of People link. |
|||
companyCode |
The code of the company. |
|||
description |
The description for the type of People link. |
|||
id |
Id in database |
|||
linkDirection |
A filation link type can be set with a link direction |
|||
static |
A link can be set as static if it is not intended to be modified |
|||
type |
A link can be set as a Management Link or a Filiation Link |
3.270. PeopleLinkTypeCriteria
Criteria used on People Link Type when doing a Link Type search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyCode |
||||
id |
||||
type |
A link can be set as a Management Link or a Filiation Link |
3.271. PeopleLinkTypeEnum
A link can be set as a Management Link or a Filiation Link
Type : enum (MANAGEMENT_LINK, FILIATION_LINK)
3.272. Period
Period
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
from |
Smaller date of the period |
date-time |
||
granularity |
To limit the granularity to a unit other than milliseconds, pass the units as the third parameter. DAY by default. |
|||
inclusivity |
Inclusivity. A [ indicates inclusion of a value. A ( indicates exclusion (for the smaller date of the period, use ) and ] for the bigger one). Inclusive by default. |
|||
to |
Bigger date of the period |
date-time |
3.273. PeriodGranularity
Granularity of a period
Type : enum (YEAR, MONTH, DAY, HOUR, MINUTE, SECOND)
3.274. Periodicity
Periodicity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Periodicity of payment (0 ⇒ Unique (default); 1 ⇒ Annual; 2 ⇒ Bi-annual; 3 ⇒ Quarterly; 4 ⇒ Monthly) |
|||
duration |
Duration in month |
double |
||
id |
Id in database |
|||
lineStartDate |
Start date of the line |
date-time |
||
startDate |
Date by which the periodicity is starting |
date-time |
||
tacitAgrement |
Returns true if the checkbox 'tacit renewal' is checked |
|||
term |
Returns true if not due, false if due |
3.276. PhaseBase
Phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a phase |
|||
id |
Id in database |
|||
name |
Name of a phase |
|||
order |
Order number of the project |
int32 |
||
project |
Details about the corresponding project |
|||
projectId |
ID of the corresponding project (i.e. Code of the project) |
3.277. PhaseState
State of a phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the phase state |
|||
companyId |
ID of the company |
|||
default |
Set as true to use this phase state by default. Set as false by default |
|||
id |
ID of the phase state |
|||
name |
The name of the phase state |
3.278. PhaseStateCriteria
Criteria used on phase state when doing a phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.279. PipeBase
Pipe base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the pipe |
|||
id |
Id in database |
|||
name |
Name of the pipe |
3.281. PluginFeature
Plugin Feature
Type : enum (BRIDGE, CHORUS, EDOC, PRESTATIONS, UNIVERSIGN, API_GOOGLE, AKUITEO_SAAS)
3.282. Postpone
Object used to postpone management object lines.
The line date can be postponed by setting a precise date, shifting by a period, or resetting the date.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
exactDate |
Precise date to be updated. |
date-time |
||
period |
Period shift information for postponing the date. To use this field, type must be set to SHIFT_BY_PERIOD. |
|||
type |
X |
Defines how the date is postponed: either by exact date, period shift, or reset. |
3.283. PostponePeriod
Defines the number of occurrences for the postponement and the time unit, allowing the date to be modified based on a given period.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
numberOfOccurrency |
Number of times the period should be shifted. |
|||
shiftPeriod |
Time unit for shifting the period. |
3.284. PostponeType
Defines how the date postponement is handled
Type : enum (EXACT_DATE, SHIFT_BY_PERIOD, RESET_DATE)
3.285. PricingMethodBase
The method by which pricing is to be determined
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the pricing method |
|||
id |
The ID in database of the pricing methods |
|||
name |
The name given to the pricing method |
3.287. ProductionInformations
Production informations
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingTargetDay |
Billing target day of the month for the production to be billed. Empty if the billing mode is not production to be billed. |
int32 |
||
defaultDisplay |
Determines whether the production is the most frequently used and should be displayed by default. Set as 'True' if the production is to be displayed by default. |
|||
estimatedDuration |
The production estimated duration in minutes. Empty if the billing mode is not production to be billed. |
int32 |
||
linkedToAdvancePayments |
Returns true if the production is linked to advance payments. Set as 'false' by default. |
|||
targetDay |
Target day of the month for the production. Empty if the billing mode is not production to be billed. |
int32 |
||
team |
Details about the production team. |
|||
teamId |
ID of the production team |
3.288. ProductionTeamBase
Production team base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the production team |
|||
id |
Id in database |
|||
name |
Name of the production team |
3.289. Profession
Details about the profession of the people
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Profession |
|||
id |
Id in database |
|||
name |
Name of the Profession |
3.290. ProfessionalCategory
Professional Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Professional Category |
|||
companyId |
ID of the company |
|||
id |
Id in database |
|||
name |
Name of the Professional Category |
|||
ranking |
The professional category ranking in the list |
int32 |
3.291. ProjectBase
Project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyCode |
Code of the company |
|||
customer |
Details of the customer |
|||
customerId |
Id of the project's customer |
|||
customerType |
Customer type |
|||
endCustomer |
Details of the customer |
|||
endCustomerId |
Id of the project's end customer |
|||
id |
Id in database |
|||
internal |
If the project is internal or not |
|||
leave |
Return true if the project is a leave project |
|||
leaveType |
Details about leave type |
|||
name |
Name of a project |
3.292. ProjectCommon
Shared information about projects, across domains.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
color |
Color of the project (hexadecimal code) |
|||
companyCode |
Code of the company |
|||
customer |
Details of the customer |
|||
customerId |
Id of the project's customer |
|||
customerType |
Customer type |
|||
endCustomer |
Details of the customer |
|||
endCustomerId |
Id of the project's end customer |
|||
id |
Id in database |
|||
internal |
If the project is internal or not |
|||
leave |
Return true if the project is a leave project |
|||
leaveType |
Details about leave type |
|||
name |
Name of a project |
|||
projectEnd (Deprecated) |
End date of a project |
date-time |
||
projectStart (Deprecated) |
Start date of a project |
date-time |
||
projectState |
State of the project |
|||
projectStateId |
Id of the state of the project |
3.293. ProjectCustomerType
Type of relation with the customers
Type : enum (ALL_CUSTOMERS, MULTI_CUSTOMERS, SINGLE_CUSTOMER)
3.294. ProjectFilterType
Type of filter on project
Type : enum (NONE, SCHEDULED_FOR_MONTH, WITH_MY_TIMESHEET, FROM_MANAGERS_IN_MY_DIVISION, FROM_MY_DIVISION, INTERNAL_IN_MY_DIVISION, FROM_MY_ENTITY, INTERNAL_IN_MY_ENTITY, MANAGED_BY_ME)
3.295. ProjectGroup
ProjectGroup
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the project group. |
|||
description |
Description of the project group. |
|||
id |
Id in database |
|||
name |
The name of the project group. |
3.297. ProjectState
State of a project
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the project state |
|||
companyCode (Deprecated) |
Code of the company |
|||
companyId |
ID of the company |
|||
id |
ID of the project state |
|||
name |
The name of the project state |
3.298. ProjectStateCriteria
Criteria used on project state when doing a project state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeModule |
Example : EXPENSE_REPORTS |
|||
code |
||||
companyId |
||||
id |
||||
name |
||||
tag |
You can fill in the code or name of the tag in this field |
3.299. ProjectTaskBase
The Project task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code (Deprecated) |
Code of the task |
|||
id |
Id in database |
|||
name |
Name of the task |
3.300. ProjectTaskCommon
The Project task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code (Deprecated) |
Code of the task |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
description |
Description of the task |
|||
endDate |
End date of the task |
date-time |
||
id |
Id in database |
|||
name |
Name of the task |
|||
order |
Order number of the task |
int32 |
||
phase |
Details about the phase of the project. |
|||
phaseId |
ID of the phase |
|||
project |
All details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
startDate |
Start date of the task |
date-time |
||
subPhase |
Details about the sub-phase of the project |
|||
subPhaseId |
ID of the sub-phase |
3.301. ProjectTaskType
The parameters of different type of project task
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
byDefault |
Set as true to use this type of task by default when adding a new task. |
|||
code |
The code to give to this project task type |
|||
companyId |
ID of the company |
|||
id |
ID of the project task type |
|||
label |
The project task type name / label |
|||
rankNumber |
The project task type ranking in the list |
|||
type |
Example : TIME_BASED |
3.303. PublishArguments
Required arguments to publish a document.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
extension |
Document type |
|||
parameters |
List of PublishTemplateParameter |
Details about the template parameters |
||
saveDocument |
Return true if the generated document is linked to the business document. |
|||
template |
Details about the template |
3.304. PublishContextBase
Context for publication, destined for use by specific API
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
contextType |
Context of the publish |
|||
displayOptions |
Map of [string] |
Options for data display |
||
filters |
Map of [array] |
Filter for data selection discriminating by object IDs grouped by object type |
3.305. PublishTemplate
Details about the template used to publish.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The template code |
|||
defaultTemplate |
Return true if it's the default's template |
|||
endDate |
End of validity of the template |
date-time |
||
extensions |
List of [string] |
Extension types available for the document |
||
id |
Id in database |
|||
interactive |
Return true if the model needs any parameters to be generated |
|||
name |
The template name |
|||
order |
Order number |
int32 |
||
path |
Path where you can find the template. |
|||
publishType |
Publish type |
|||
type |
Details about the template type |
3.306. PublishTemplateParameter
Parameters of a Publish template.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controlType |
Details about the type of the parameter |
|||
groupName |
Name of the parameter group |
|||
labelText |
Label of the parameter |
|||
nameField |
Name of the parameter |
|||
nameFieldNext |
Name of the next parameter |
|||
pattern |
Pattern of the parameter |
|||
required |
Return true if the paramater is required |
|||
selectionList |
List of PublishTemplateParameterChoice |
Details of each value of a LIST_BOX parameter |
||
value |
Value of the parameter |
3.307. PublishTemplateParameterChoice
If controlType is equal to LIST_BOX, there is a list of each object in the list
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
label |
The label |
|||
value |
The value |
3.308. PublishTemplateParameterType
Type of parameter.
Type : enum (TEXT_BOX, LIST_BOX, DATE_BOX, RADIO_BUTTON, CHECK_BOX, COMBO_BOX)
3.309. PublishTemplateType
Describe the Publish template type which is unique by code-modelId tuple. Allowed ModelId values depend on choosen code value.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the template type |
|||
modelDescription |
Description of the model |
|||
modelId |
ID of the model |
|||
name |
Name of the template type |
3.310. PublishType
Type of the published document.
Defines the type of document that can be published. Some objects can be published individually, while others support batch publishing. For batch publishing, use the type ending with 'LIST.'
Type : enum (OPPORTUNITY, QUOTATION, QUOTATION_LIST, SALES_ORDER, SALES_ORDER_LIST, SALES_INVOICE, SALES_INVOICE_LIST, SALES_BILLING_TABLE, SALES_BILLING_TABLE_LIST, DELIVERY, DELIVERY_LIST, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, PURCHASE_BILLING_TABLE, RECEPTION, CUSTOMER, CUSTOM_REQUEST, EXPENSE_REPORT, EXPENSE, EXPENSE_REPORT_LIST, SCHEDULE, SCHEDULE_EMPLOYEE, TIMERECORDING, ISSUE, PRODUCTION_TO_BE_BILLED, OVERVIEW_HELPDESK, OVERVIEW_PURCHASE, OVERVIEW_SALES, OVERVIEW_SCHEDULE, OVERVIEW_TIMESHEET, OVERVIEW_STOCK, OVERVIEW_COMMON, OVERVIEW_MISCELLANEOUS, PROJECT, PROJECT_LIST, CONTACT, QUOTATION_EXPENSE_LINE, BANKING_INFORMATION)
3.311. PublishedDocument
Published Document.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
documentId |
Document ID |
|||
isDocument |
Return true if the document is available in Akuiteo |
|||
token |
Details about the published document (whether the publish is okay or not, where you can find the document, its size) |
3.312. RecipientContact
Contact recipient of a management object
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
companyId |
ID of the company |
|||
contactId |
The ID of the contact |
|||
The email of the contact recipient |
||||
firstName |
The first name of the contact recipient |
|||
id |
Id in database |
|||
name |
The name of the contact recipient . |
|||
title |
Civility of the contact recipient |
|||
type |
Example : IN_COPY |
3.314. RecurringAmountsInfo
Amounts calculated based on the recurrence period defined in the management object lines.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
afterTaxAmount |
After-tax amount in the company currency, calculated automatically, considering any recurrence |
double |
||
afterTaxAmountCurrency |
After-tax amount in the specified currency, calculated automatically, considering any recurrence |
double |
||
preTaxAmount |
Pre-tax amount in the company currency, calculated automatically, considering any recurrence |
double |
||
preTaxAmountCurrency |
Pre-tax amount in the specified currency, calculated automatically, considering any recurrence |
double |
||
vatAmount |
VAT amount expressed in the company currency |
double |
||
vatAmountCurrency |
VAT amount expressed in the specified currency |
double |
3.315. Region
Region
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the region |
|||
companyCode |
The code of the company linked to the region |
|||
companyId |
ID of the company |
|||
country |
The country where the region is located |
|||
countryId |
Id of the country where the region is located |
|||
id |
Id in database |
|||
name |
Name of the region |
3.317. SEPA
Details SEPA banking information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
bankDetails |
Details about the bank |
|||
bic |
Details about the BIC |
|||
iban |
Details about the IBAN |
3.318. ScheduleBase
Schedules
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCodeId |
ID of the action code |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
description |
Description of the schedule |
|||
done |
Return True if the schedule is done |
|||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.319. SearchControlBehavior
Detail about behavior and area to display the field
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
controlBehavior |
Details about the control behavior linked to the field |
|||
searchFieldInformation |
Details about the area linked to the field |
3.320. SearchFieldInformation
Informations sur un champ utilisé dans la configuration de la recherche. Le champ peut être affiché dans une zone différente en fonction du champ principal ou secondaire.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categorySection |
The section in which the search field will be displayed. |
|||
categoryTab |
The tab in which the search field will be displayed. |
|||
code |
The code of the search field |
|||
fieldOrder |
Order number of the field |
int32 |
||
group |
Membership group of the field |
|||
id |
The Id of the search field |
|||
name |
The name of the search field |
|||
primary |
True when the search field is primary and will be displayed in the main search area |
|||
searchType |
The type of the search field |
|||
secondary |
True when the search field is secondary and will be displayed in the secondary search area. |
|||
sectionOrder |
Order number of the section |
int32 |
||
tabOrder |
Order number of the tab |
int32 |
3.321. SearchFieldType
Type of search field
Type : enum (DROPDOWN_LIST, DATE, TEXT, BOOLEAN, NUMBER)
3.322. SearchType
Type of search
Type : enum (PIPELINE_KANBAN, OPPORTUNITY, QUOTATION, SALES_ORDER, SALES_BILLING_TABLE, DELIVERY, SALES_INVOICE, CUSTOMER, SOLD_ITEM, QUOTE, PURCHASE_ORDER, PURCHASE_BILLING_TABLE, RECEPTION, PURCHASE_TEMPORARY_INVOICE, PURCHASE_INVOICE, CONTACT, EVENT, EMPLOYEE, PROJECT, PROJECT_TASK, ISSUE, SPRINT_CARD, PROJECT_EVENT, TIMESHEET_ENTRY, SCHEDULE, LEAVE_REQUEST_EMPLOYEE, EXPENSE_REPORT_EMPLOYEE, CUSTOM_REQUEST, PRODUCTION_TO_BILL_EMPLOYEE, PRODUCTION_TO_BILL_MANAGER, LEAVE_REQUEST_MANAGER, APPROVAL, EXPENSE_REPORT_MANAGER, SCHEDULE_BY_PROJECT, SCHEDULE_BY_EMPLOYEE, SCHEDULE_TIMESTAMPED, SCHEDULE_WORKLOAD, TASK_MANAGER)
3.323. Sector
Sector
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the Sector |
|||
companyId |
ID of the company |
|||
endDate |
The end date of the Sector. |
date-time |
||
id |
Id in database |
|||
name |
Name of the Sector |
|||
ranking |
The sector ranking in the list |
int32 |
3.324. SelectOption
Option used to get select resource fields when doing a search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fields |
List of [string] |
List of the select option fields |
||
mode |
Mode of fields selection. If INCLUDE or EXCLUDE without fields all fields will be included |
Enum: INCLUDE, EXCLUDE, INCLUDE, EXCLUDE |
3.325. Service
Service
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the service |
|||
id |
Id in database |
|||
name |
Name of the service |
3.326. ShiftPeriod
Time unit for shifting the period.
Type : enum (YEAR, HALF_YEAR, QUARTER, MONTH, WEEK, DAY)
3.327. Skill
Skill of an employee
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the skill |
|||
id |
Id in database |
|||
name |
Name of the skill |
|||
typeCode |
Code of the skill's type |
|||
typeLabel |
Label of the skill's type |
3.328. SoldItem
Sold item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
accountSettings |
Accounting information for an item. |
|||
automaticTitle |
Automatic title for a sold item, used for structuring and hierarchization of elements that utilize this sold item. |
|||
billingMode |
defaut billing mode for the item |
|||
category |
All details about the category of the product |
|||
categoryId |
The Id of the category |
|||
comment |
Comment on the product |
|||
companyCode |
The company code |
|||
customData |
Map of CustomData |
All custom data to update |
||
entityCode |
The entity code |
|||
family (Deprecated) |
The category of the product |
|||
grouping |
The grouping of the product |
|||
id |
Id in database |
|||
inventory |
Returns true if the product is in the inventory |
|||
inventoryAndPackaging |
Details about Inventory and Packaging |
|||
name |
Identification name |
|||
productionEstimatedDuration |
Estimated duration in minutes |
double |
||
productionInformations |
Details about productions informations |
|||
quantityPrecision |
Number of decimals for this item quantity |
double |
||
reference |
The reference of the product |
|||
shortName |
Abbreviated designation |
|||
subCategory |
All details about the sub-category of the product |
|||
subCategoryId |
The Id of the sub-category |
|||
subFamily (Deprecated) |
The sub-category of the product |
|||
unitPricePrecision |
Number of decimals for this item unit price |
double |
3.329. SoldItemCriteria
Search criteria for sold items
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
billingMode |
Billing mode for the sold item |
|||
categoryId |
The ID of the category |
|||
companyCode |
Code of the company |
|||
customData |
Map of Clause |
The custom data (when present) |
||
defaultDisplay |
Set as “True” to load only productions should be displayed by default. If not specified, all productions are loaded. |
|||
entityId |
Ident of the entity of the sold item |
|||
grouping |
Grouping of the sold item |
|||
id |
Ident of the sold item |
|||
inventory |
Returns true if the product is in the inventory |
|||
linkedToAdvancePayments |
Set as True to return production linked to advance payments. |
|||
marketEndDate |
End-of-sale date for the sold item. Indicates when the product stopped being available for sale |
|||
name |
Identification name |
|||
packagingType |
The packaging type of the sold item |
|||
readOption |
Options for retrieving extra information concerning the billing table |
|||
reference |
Reference of the sold item |
|||
subCategoryId |
The ID of the sub category |
|||
tag |
You can fill in the reference or grouping of the tag in this field |
|||
teamId |
The ID of the production team |
|||
validity |
Details about the validity of the sold item |
3.330. SoldItemReadOption
ReadOption of a SoldItem
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sold item |
Enum: PRODUCTION_INFORMATIONS, PRODUCTION_INFORMATIONS_TEAM, CATEGORY, SUB_CATEGORY, CUSTOM_DATA |
3.331. SortField
Couple field/sort type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
fieldName |
Name of the field |
|||
order |
Sort type. (ASC or DESC) |
3.333. StageBase
Oppportunity Stage Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the opportunity stage |
|||
id |
Id in database |
|||
name |
Name of the opportunity stage |
3.335. StandardWeekBase
Represents a standard week configuration, typically used to define recurring working patterns (e.g., default work week).
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the standard week |
|||
id |
Id in database |
|||
name |
Name of the standard week |
3.336. StatusFilter
Filtering criteria based on resource status.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
dateOperator |
Defines how the reference date is used to filter resources based on whether they have the specified status or not. |
|||
isActive |
Indicates whether the resource status is active or inactive. |
|||
referenceDate |
The reference date to check the status of the resource. If not provided, the current date is used by default. |
date-time |
3.337. StringParamHolder
Parameter value (String).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Value |
3.338. StringsParamHolder
Parameter value (Array[String]).
See the documentation of the calling API body for further information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
List of [string] |
Value |
3.339. SubCategory
Sub-Category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category |
Details about the category |
|||
categoryId |
The Id of the category |
|||
code |
The code of the sub-category |
|||
company |
Details about the company |
|||
companyCode (Deprecated) |
The code of the company |
|||
companyId |
ID of the company |
|||
endDate |
End date for using the sub-category |
date |
||
grouping |
Grouping field for sub-category |
|||
id |
Id in database |
|||
name |
The name of the sub-category |
|||
ranking |
Sub-category ranking in help lists |
int32 |
||
type |
Type of the category. |
3.340. SubCategoryCriteria
Criteria used on sub-category when doing a sub-category search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categoryId |
Category's ident of the sub-category |
|||
code |
Code of the sub-category |
|||
companyId |
Company of the sub-category |
|||
endDate |
End date of validity for the sub-category |
|||
grouping |
Grouping field of the sub-category |
|||
id |
Ident of the sub-category |
|||
name |
Name of the sub-category |
|||
nature |
Nature of the sub-category |
|||
readOption |
Options for retrieving extra information concerning the sub-category |
|||
tag |
You can fill in the code or name of the sub-category in this field |
|||
type |
Type of the sub-category |
|||
validity |
Details about the validity of the sub-category |
3.341. SubCategoryItem
Sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
category |
Details about the category |
|||
categoryId |
The Id of the category |
|||
code |
The code of the sub-category |
|||
company |
Details about the company |
|||
companyCode (Deprecated) |
The code of the company |
|||
companyId |
ID of the company |
|||
endDate |
End date for using the sub-category |
date |
||
grouping |
Grouping field for sub-category |
|||
id |
Id in database |
|||
name |
The name of the sub-category |
|||
ranking |
Sub-category ranking in help lists |
int32 |
||
subCategoryType |
Type of the purchased item sub-category |
|||
type |
Type of the category. |
3.342. SubCategoryItemClassification
Purchased item sub-category classification
Type : enum (EXTERNAL, INTERNAL, NOT_SPECIFIED, OTHERS, PRICE_REVIEW)
3.343. SubCategoryItemCriteria
Criteria used to get more details about Sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
categoryId |
The Id of the category |
|||
code |
The code of the sub-category item |
|||
companyId |
The Id of the company |
|||
endDate |
End date of validity for the sub-category item |
|||
grouping |
Grouping field for sub-category item |
|||
id |
The Id of the sub-category item |
|||
name |
Name of the sub-category item |
|||
nature (Deprecated) |
Nature of the sub-category item |
|||
readOption |
Options for retrieving extra information concerning the sub-category of an item |
|||
subCategoryType |
Type of the purchased item sub-category item |
|||
tag |
You can fill in the code or name of the sub-category item in this field |
|||
type |
Type of the sub-category item. |
|||
validity |
Details about the validity of the sub-category item |
3.344. SubCategoryItemReadOption
The options you can use to get more information about the sub category of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sub category of an item |
Enum: CATEGORY, COMPANY |
3.345. SubCategoryItemType
Sub type of a sub category of an item
Type : enum (PRESTATION, DISTRIBUTION, FRAIS_DE_MISSION, ACOMPTE, DIVERS, NON_RENSEIGNE, LICENCE, MAINTENANCE, DEVELOPPEMENT, SOUS_TRAITANCE, FRAIS_DE_PORT, ABONNEMENT, FORMATION)
3.346. SubCategoryReadOption
The options you can use to get more information about the sub category
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the sub category |
Enum: CATEGORY, COMPANY |
3.347. SubPhaseBase
SubPhase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of a sub-phase |
|||
id |
Id in database |
|||
name |
Name of a sub-phase |
|||
order |
Order number of the sub-phase |
int32 |
||
phase |
Details about the corresponding phase |
|||
phaseId |
ID of the corresponding phase |
3.348. SubPhaseState
State of a sub-phase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the sub-phase state |
|||
companyId |
ID of the company |
|||
id |
ID of the sub phase state |
|||
name |
The name of the sub-phase state |
3.349. SubPhaseStateCriteria
Criteria used on sub-phase state when doing a sub-phase state search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
||||
companyId |
||||
id |
||||
name |
3.350. SubledgerAccountBase
Subledger account (ident example AKSAS22106800)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
3.351. SubledgerAccountCommon
Subledger account
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Subledger account label |
|||
number |
Subledger account number |
3.352. Subscription
Subscription to listen events using SSE
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
excludeMyOwnEvents |
Set as true to exclude the event of which I am the author. |
|||
token |
The token code allocated to the susbscription. |
|||
topic |
Topic to listen events |
3.353. SupplierBase
Suppliers
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.354. SupplierSiteBase
Supplier Site Base (Site Fournisseur)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
name |
Name of the supplier site |
|||
supplierId (Deprecated) |
Warning : The supplier ID cannot be changed once the supplier site has been created. Any modification will not be taken into account. |
3.356. SupplierVariety
The variety of the supplier.
SUPPLIER_EMPLOYEE is set if the supplier is refers to an employee.
Type : enum (SUPPLIER_EMPLOYEE, SUPPLIER, ALL)
3.358. Tag
Tag
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the tag |
|||
color |
Color of the tag |
|||
comment |
Comment of the tag |
|||
companyId |
ID of the company |
|||
endDate |
End of validity of the tag |
date-time |
||
icon |
Icon of the tag |
|||
id |
Id in database |
|||
name |
Name of the tag |
|||
type |
Type of the tag |
3.359. TagCriteria
Criteria used when doing a tag search
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the tag |
|||
companyId |
Ident of the company |
|||
id |
Ident of the tag |
|||
name |
Name of the tag |
|||
tag |
You can fill in the code or name of the tag in this field |
|||
type |
Type of the tag |
|||
validity |
Details about validity |
3.360. TagLinked
Tag linked
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
Details about the action verb |
|||
code |
Code of the tag |
|||
color |
Color of the tag |
|||
comment |
Comment of the tag |
|||
companyId |
ID of the company |
|||
endDate |
End of validity of the tag |
date-time |
||
icon |
Icon of the tag |
|||
id |
Id in database |
|||
name |
Name of the tag |
|||
objectId |
ID of the linked object |
|||
type |
Type of the tag |
3.362. TaskBase
Task base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
3.363. TaskBillingType
The list of value of billing type of the type of project task.
Type : enum (TIME_BASED, TIME_BASED_FIXED_PRICE_MONTHLY)
3.364. TaskCommon
Task common
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Id in database |
|||
number |
The number of the task. |
int32 |
3.365. TaxInformation
Tax Information
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
VATAreaId (Deprecated) |
The Id of the VAT Area |
|||
VATNumber (Deprecated) |
The number of the VAT rate |
|||
euExempt |
The 'euExempt' field indicates whether Intracommunity VAT exemption applies. |
|||
exempt |
The 'exempt' field indicates whether there is VAT exemption. |
|||
vatArea |
Details about the VAT Area. |
|||
vatAreaId |
The Id of the VAT Area |
|||
vatNumber |
The number of the VAT rate |
3.366. TemplatedMessage
A message is a combination of a Mail (used to store standard information for sending a mail) and functional information. This functional information is processed by backend service to compute standard information for sending mail like an employee's email address.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
message |
||||
parameters |
List of PublishTemplateParameter |
Details about the template parameters |
||
templateId |
The publish template needed to generate and attach the report |
3.367. ThirdPartyBase
Third Party Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the third party (customer, supplier, other third party). |
|||
id |
Id in database |
|||
name |
The name of the third party (customer, supplier, other third party). |
3.368. ThirdPartyLinkType
Third Party Link Type
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of third party link type |
|||
company |
Details about the company |
|||
companyId |
The Id of the company |
|||
endDate |
End date for third party link type. When the date is reached, the type can no longer be used. |
date-time |
||
id |
ID in database |
|||
name |
The name of third party link type |
|||
requiredSiren |
Set as 'true' to make SIREN entry mandatory for this type. |
3.369. ThirdPartyTypeEnum
A type of the third party with people links
Type : enum (PROSPECT, CUSTOMER, SUPPLIER, OTHER_THIRD_PARTY)
3.370. Timeline
Timeline which define the initial date, the expected date and the actual date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualDate |
The actual or effective date. |
date-time |
||
expectedDate |
The currently expected date. |
date-time |
||
initialDate |
The initially defined date. |
date-time |
3.371. TimelineCriteria
Timeline criteria which define the initial date, the expected date and the actual date
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actualDate |
The actual or effective date. |
|||
expectedDate |
The currently expected date. |
|||
initialDate |
The initially defined date. |
3.372. TimesheetEntryBase
TimesheetEntryBase
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
actionCode |
Details about the action verb |
|||
actionCode2 |
Details of the action code |
|||
actionCode2Id |
ID of the second action code |
|||
actionCodeId |
ID of the action code |
|||
approval |
Approval of the timesheet entry |
Enum: BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE, BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE |
||
approvalLabel |
Label of the approval |
|||
changeTracking |
Date and user in case of creation and modification |
|||
comment |
Comment of the calendar event |
|||
completionDate |
Completion Date |
date-time |
||
customer |
Details about the customer |
|||
customerId |
ID of the customer |
|||
date |
Date of the calendar event |
date-time |
||
duration |
Duration of the calendar event |
double |
||
durations |
Duration in different units |
|||
employee |
Details about the employee |
|||
employeeId |
ID of the employee |
|||
guid |
Global identifier of the calendar event (for mobile version only) |
|||
id |
ID of the calendar event |
|||
location |
Location of the calendar event |
|||
phase |
Details about the phase |
|||
phaseId |
ID of the phase |
|||
project |
Details about the project |
|||
projectId |
ID of the project (equivalent to the code of the project) |
|||
projectTask |
Details about the task |
|||
projectTaskId |
ID of the project |
|||
subPhase |
Details about the sub-phase |
|||
subPhaseId |
ID of the sub-phase |
|||
taskId |
Helpdesk's task ident |
|||
type |
Type of the calendar event |
|||
unit |
Details about the unit of duration |
|||
validated |
Return True if the calendar event is validated |
3.373. Title
Title / Marriage status
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the title |
|||
companyId |
ID of the company |
|||
id |
Id of the title |
|||
name |
Name of the title |
|||
order |
Order number of the title |
int32 |
||
titleType |
Type of the title |
3.375. Topic
Topic to listen events
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
action |
The action verb (ADD / UPDATE / REMOVE). |
|||
id |
ID of the topic |
|||
type |
Type of event. |
3.376. TransactionStatus
Transaction status for electronic signatures
Type : enum (IN_PROGRESS, CANCELED, EXPIRED, COMPLETED)
3.378. UnitDuration
Unit of duration
Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE, UNIT_OF_COMPANY)
3.379. UnitPrice
Unit price of an item
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
value |
Unit price of an item |
double |
3.380. UserBase
User
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the user |
|||
firstName |
First name of the user |
|||
id |
Id in database |
|||
name |
Name of the user |
3.381. UserCriteria
UserCriteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
||||
readOption |
Options for retrieving extra information concerning the user |
|||
tag |
Code or Last Name or First Name of the User |
3.382. UserInfo
User Info
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
codeCompany |
The company code of the user info |
|||
codeUser |
Code of the user |
|||
defaultAssignment |
The default mob affectation |
|||
devise |
The mob devise of the user info |
|||
The email of the user |
||||
features |
List of ApplicationFeature |
List of application features |
||
firstName |
The first name of the user |
|||
identEmployee |
ID of the employee |
double |
||
identUser |
ID of the user |
double |
||
lastName |
The last name of the user |
|||
photo |
The photo of the user |
|||
usesSaml |
User authenticated by SAML IDP |
|||
version |
Version of the user info |
3.383. UserProfileBase
User Profile Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
Code of the user profile |
|||
id |
Id in database |
|||
name |
Name of the user profile |
3.384. UserReadOption
Options used to get additional information on user
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
options |
List of [string] |
List of options used to get more details about the user |
Enum: EMPLOYEE |
3.385. VAT
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
companyCode |
The company code |
|||
endDate |
End date of the VAT |
date-time |
||
id |
Id in database |
|||
name |
Name |
|||
purchasingAccountNumber |
General purchasing account number linked to the tax code |
|||
rate |
VAT rate in percentage |
double |
||
reduced |
Returns true if the rate is reduced |
|||
salesAccountNumber |
General sales account number linked to the tax code |
|||
startDate |
Start date of the VAT |
date-time |
3.386. VATAreaBase
VAT Area Base
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the VAT area |
|||
id |
Id in database |
|||
name |
The name of the VAT area |
3.387. VATBase
VAT
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
VAT code |
|||
id |
Id in database |
|||
rate |
VAT rate in percentage |
double |
3.388. Validity
Validity criteria
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
date |
Date of validity of the item |
date-time |
||
type |
Details about the type of validity. |
3.390. Year
Year (vintage) of the opportunity
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the year (vintage). |
|||
disabledDate |
Date of disability |
date-time |
||
id |
Id in database |
|||
name |
The name of the year (vintage). |
|||
previousYearId |
Previous year (vintage) ID. |
|||
repeating |
Set as true if the vintage is recurrent. |
|||
validityEndDate |
The end date of validity. |
date-time |
3.391. YearCriteria
Criteria used to search Year (vintage)
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
code |
The code of the year (vintage) |
|||
companyId |
ID of the company |
|||
disabledDate |
Date on which the year will become inactive |
|||
id |
The ID of the year (vintage) |
|||
name |
The name of the year (vintage) |
|||
previousYearId |
Previous year (vintage) ID |
|||
validityEndDate |
Validity applicable on end date of the year |
4. Access
-
HTTP Basic Authentication BasicAuth BasicAuth
-
OAuth AuthorizationUrl: _, TokenUrl: _https://api.akuiteo.fr/akuiteo/oauth2/token
Unresolved directive in index.adoc - include::../../dist/deprecated.adoc[]
Unresolved directive in index.adoc - include::../../dist/lexique.adoc[]
Publication date : 2025-10-02 11:46:23
Copyright : Akuiteo © 2025