1. Overview

Manage Akuiteo sales domain by REST Api

1.1. Version information

Version : 2.0.0

1.2. Contact information

Contact Email : admin@akuiteo.com

1.3. License information

License : Commercial
License URL : https://www.akuiteo.com/mentions-legales
Terms of service : null

1.4. URI scheme

Host : api.akuiteo.fr
BasePath : /akuiteo/rest/sales
Schemes : HTTPS

1.5. Tags

  • Billing Tables : Billing Tables

  • Invoices : Invoices

  • Orders : Orders

  • Quotations : Quotations

  • Sales : Sales Management

  • Time-based Billing : Time-based Billing

1.6. 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+200"

  • 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. Billing Tables

Billing Tables

2.1.1. Force VAT Amounts on a billing table

POST /billing-table/{billing_table_id}/force-vat-amount
Description

Force vat amounts on billing table lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

billing_table_id
required

The id of a billing table

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on billing table lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more billing table line have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.2. Invoices

Invoices

2.2.1. Force VAT Amounts on the invoice

POST /invoices/{invoice_id}/force-vat-amount
Description

Force vat amounts on invoice’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on invoice lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more invoice have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.3. Orders

Orders

2.3.1. Force VAT Amounts on the order

POST /orders/{sales_order_id}/force-vat-amount
Description

Force vat amounts on order’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on order lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more order lines have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.4. Quotations

Quotations

2.4.1. Force VAT Amounts on the quotation

POST /quotations/{quotation_id}/force-vat-amount
Description

Force vat amounts on quotation’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

quotation_id
required

The id of the quotation

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on quotation lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more quotation lines have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.5. Sales

Sales Management

2.5.1. Force VAT Amounts on a billing table

POST /billing-table/{billing_table_id}/force-vat-amount
Description

Force vat amounts on billing table lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

billing_table_id
required

The id of a billing table

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on billing table lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more billing table line have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.5.2. Search for invoices (with search criteria)

POST /invoices/search
Description

Get the list of invoices matching the search criteria.

DMF required:

  • DMF AB0304: Search an invoices

Parameters
Type Name Description Schema

Body

criteria
required

Criteria that you choose (ID, Customer, etc…)

InvoiceCriteria
Responses
HTTP Code Description Schema

200

Invoice successfully loaded

< Invoice > array
Consumes

  • application/json

Produces

  • application/json

2.5.3. Book invoice

POST /invoices/{invoice_id}/book
Description

Book an invoice with its id and a date

DMF required:

  • DMF AB0306: Book an invoice

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string

Body

date
required

The booking date

DateParamHolder
Responses
HTTP Code Description Schema

200

Booked invoice number

string
Consumes

  • application/json

Produces

  • application/json

2.5.4. Force VAT Amounts on the invoice

POST /invoices/{invoice_id}/force-vat-amount
Description

Force vat amounts on invoice’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on invoice lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more invoice have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.5.5. Get expense receipts linked to an invoice

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

Get expense receipts of the invoice matching the given id.

DMF required:

  • DMF AB0305: Publish an invoice

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string
Responses
HTTP Code Description Schema

200

Linked expense receipts

< ExpenseReceiptSummary > array
Consumes

  • application/json

Produces

  • application/json

2.5.6. Identify expenses rebilled to customers

POST /invoices/{invoice_id}/is-expense-rebill
Description

Return true if the invoice contains an expense which has been rebilled

DMF required:

  • DMF AB0305: Publish an invoice

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string
Responses
HTTP Code Description Schema

200

Return true if the invoice is a rebill of an expense report

boolean
Consumes

  • application/json

Produces

  • application/json

2.5.7. Publish an invoice

POST /invoices/{invoice_id}/publish
Description

Publish an invoice using the template given as a parameter.

DMF required:

  • DMF AB0305: Publish an invoice

Parameters
Type Name Description Schema

Path

invoice_id
required

The id of the sales invoice

string

Query

join_expense_receipts
optional

True to join the receipts of the linked expenses in the published document

boolean

Body

publish_arguments
required

The arguments for publishing invoice

PublishArguments
Responses
HTTP Code Description Schema

200

Published document

PublishedDocument
Consumes

  • application/json

Produces

  • application/json

2.5.8. Advanced search for orders

POST /orders/dashboard
Description

This API provides an advanced search for sales orders. The search results can be processed: categorization, groupings, total amounts..

DMF required:

  • DMF 020304: Search an order

Parameters
Type Name Description Schema

Body

criteria
optional

search criteria

SalesOrderDashboardCriteria
Responses
HTTP Code Description Schema

200

Sales order results successfully loaded

< SalesOrderDashboardResult > array
Consumes

  • application/json

Produces

  • application/json

2.5.9. Search for orders (with search criteria)

POST /orders/search
Description

Get the list of orders matching the search criteria.

DMF required:

  • DMF 020304: search an order.

Parameters
Type Name Description Schema

Body

criteria
required

Criteria that you choose (ID, Customer, etc…)

SalesOrderCriteria
Responses
HTTP Code Description Schema

200

Orders successfully loaded

< SalesOrder > array
Consumes

  • application/json

Produces

  • application/json

2.5.10. Search an order by its ID

GET /orders/{sales_order_id}
Description

Get the order matching the specified ID.

DMF required:

  • DMF 0203**: All features in the order module.

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string
Responses
HTTP Code Description Schema

200

Order successfully loaded

SalesOrder
Produces

  • application/json

2.5.11. Force VAT Amounts on the order

POST /orders/{sales_order_id}/force-vat-amount
Description

Force vat amounts on order’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on order lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more order lines have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.5.12. Publish an order

POST /orders/{sales_order_id}/publish
Description

Publish an order using the template given as a parameter.

DMF required:

  • DMF AB0205: Publish an order

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

publish_arguments
required

The arguments for publishing order

PublishArguments
Responses
HTTP Code Description Schema

200

published document

PublishedDocument
Consumes

  • application/json

Produces

  • application/json

2.5.13. Search an order with read options

POST /orders/{sales_order_id}/read
Description

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

DMF required:

  • DMF 0203**: All features in the order module.

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

read_option
optional

the read options for returned sales order

SalesOrderReadOption
Responses
HTTP Code Description Schema

200

Order successfully loaded

SalesOrder
Consumes

  • application/json

Produces

  • application/json

2.5.14. Create a quotation

PUT /quotations
Description

Create a quotation using the list of parameters below.

DMF required:

  • DMF AB0101: Create a quotation.

Parameters
Type Name Description Schema

Body

quotation
required

The quotation to create

Quotation
Responses
HTTP Code Description Schema

200

Quotation successfully created

string
Consumes

  • application/json

Produces

  • application/json

2.5.15. Search for quotations (with search criteria)

POST /quotations/search
Description

Get the list of quotations matching the search criteria.

DMF required:

  • DMF 020204: search a quotation.

Parameters
Type Name Description Schema

Body

criteria
required

Criteria that you choose (ID, Customer, etc…)

QuotationCriteria
Responses
HTTP Code Description Schema

200

Quotations successfully loaded

< Quotation > array
Consumes

  • application/json

Produces

  • application/json

2.5.16. Search a quotation by its ID

GET /quotations/{quotation_id}
Description

Get the quotation matching the specified ID.

DMF required:

  • DMF 0202**: All features in the quotation module.

Parameters
Type Name Description Schema

Path

quotation_id
required

The id of the quotation

string
Responses
HTTP Code Description Schema

200

Quotation successfully loaded

Quotation
Produces

  • application/json

2.5.17. Force VAT Amounts on the quotation

POST /quotations/{quotation_id}/force-vat-amount
Description

Force vat amounts on quotation’s lines

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

quotation_id
required

The id of the quotation

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on quotation lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more quotation lines have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.5.18. Publish a quotation

POST /quotations/{quotation_id}/publish
Description

Publish a quotation using the template given as a parameter.

DMF required:

  • DMF AB0105: Publish a quotation.

Parameters
Type Name Description Schema

Path

quotation_id
required

The id of the quotation

string

Body

publish_arguments
required

The arguments for publishing quotation

PublishArguments
Responses
HTTP Code Description Schema

200

published document

PublishedDocument
Consumes

  • application/json

Produces

  • application/json

2.5.19. Search a quotation with read options

POST /quotations/{quotation_id}/read
Description

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

DMF required:

  • DMF 0202**: All features in the quotation module.

Parameters
Type Name Description Schema

Path

quotation_id
required

The id of the quotation

string

Body

read_option
optional

the read options for returned quotation

QuotationReadOption
Responses
HTTP Code Description Schema

200

Quotation successfully loaded

Quotation
Consumes

  • application/json

Produces

  • application/json

2.5.20. Search for sold items (with search criteria)

POST /sold-items/search
Description

Get the list of sold items matching the search criteria.

DMF required:

  • DMF 050204: Search a sold item

Parameters
Type Name Description Schema

Body

criteria
required

Criteria that you choose (ID, Customer, etc…)

SoldItemCriteria
Responses
HTTP Code Description Schema

200

Purchased items successfully loaded

< SoldItem > array
Consumes

  • application/json

Produces

  • application/json

2.5.21. Bill customer with time-based billing

POST /time-based-billing/customer/{customer_id}/deliveries/generate-and-bill
Description

Bill all ongoing orders of the specified customer using time-based billing

DMF required:

  • DMF AB0410: Time-based billing

Parameters
Type Name Description Schema

Path

customer_id
required

The id of the customer

string

Body

objects_to_delivery
required

The parameters for a time-based billing of a customer sales order and expenses

ObjectsToDeliveryTimeBasedBilling
Responses
HTTP Code Description Schema

200

delivery numbers

< string > array
Consumes

  • application/json

Produces

  • application/json

2.5.22. Bill sales order with time-based billing

POST /time-based-billing/sales-order/{sales_order_id}/bill
Description

Bill the order given in parameter with time-based billing

DMF required:

  • DMF AB0410: Time-based billing

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

objects_to_delivery
required

Parameters for a time-based billing of an order

ObjectsToDeliveryTimeBasedBilling
Responses
HTTP Code Description Schema

200

delivery number

string
Consumes

  • application/json

Produces

  • application/json

2.5.23. Force VAT Amounts on a business document

POST /{business_document_type}/{business_document_id}/force-vat-amount
Description

Force vat amounts on the line of a specified type of business document

DMF Required:

  • DMF AB0107: Force vat amount

Parameters
Type Name Description Schema

Path

business_document_id
required

The id of the object

string

Path

business_document_type
required

type of a Sales Business Document

string

Body

forced_vat_amount_list
optional

Information to force VAT amount on sales document lines

< ForcedVatAmountHolder > array
Responses
HTTP Code Description Schema

200

Return true if one or more sales line have been modified

boolean
Consumes

  • application/json

Produces

  • application/json

2.6. Time-based Billing

Time-based Billing

2.6.1. Bill customer with time-based billing

POST /time-based-billing/customer/{customer_id}/deliveries/generate-and-bill
Description

Bill all ongoing orders of the specified customer using time-based billing

DMF required:

  • DMF AB0410: Time-based billing

Parameters
Type Name Description Schema

Path

customer_id
required

The id of the customer

string

Body

objects_to_delivery
required

The parameters for a time-based billing of a customer sales order and expenses

ObjectsToDeliveryTimeBasedBilling
Responses
HTTP Code Description Schema

200

delivery numbers

< string > array
Consumes

  • application/json

Produces

  • application/json

2.6.2. Bill sales order with time-based billing

POST /time-based-billing/sales-order/{sales_order_id}/bill
Description

Bill the order given in parameter with time-based billing

DMF required:

  • DMF AB0410: Time-based billing

Parameters
Type Name Description Schema

Path

sales_order_id
required

The id of the sales order

string

Body

objects_to_delivery
required

Parameters for a time-based billing of an order

ObjectsToDeliveryTimeBasedBilling
Responses
HTTP Code Description Schema

200

delivery number

string
Consumes

  • application/json

Produces

  • application/json

3. Definitions

3.1. AccountingJournal

Accounting Journal

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the accounting journal
Example : "ACC"

string

id
required

Id in database

string

name
optional

Name of the accounting journal
Example : "Accounting Journal"

string

type
optional

Details about the journal type

JournalType

3.2. Action

Verb of the request to specify which type of action you will send.

Type : enum (ADD, UPDATE, REMOVE)

3.3. ActionCode

Details about the action code

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

name
optional

Name of the action code
Example : "ADD"

string

3.4. ActionCode2

Details about the second action code

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the second action code
Example : "ADD"

string

id
required

Id in database

string

name
optional

Name of the action code
Example : "ADD"

string

3.5. ActiveModule

List of active modules

Type : enum (EXPENSE_REPORTS, TIMES_RECORDING, SCHEDULE, QUOTATION, SALES_ORDER, INVOICE, PURCHASE_ORDER, QUOTE, RECEPTION, PURCHASE_INVOICE)

3.6. Activity

Division

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the activity

string

departmentId
optional

Ident of the department
Example : "320014"

string

endDate
optional

End of validity
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

Name of the activity

string

3.7. Address

Details about the address

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

cedex
optional

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

string

city
optional

City of the address
Example : "London"

string

country
optional

Country of the address
Example : "Korea"

string

department
optional

Department of the address

string

email
optional

email of the address

string

fax
optional

Fax of the address

string

id
required

Id in database

string

line1
optional

First line of the address
Example : "221B Baker Street"

string

line2
optional

Second line of the address
Example : "2nd Floor"

string

line3
optional

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

string

mobilePhone
optional

Mobile Phone of the address

string

phone
optional

Phone of the address

string

postalCode
optional

Postal code of the city
Example : "69002"

string

region
optional

Region of the address

string

webSite
optional

Web Site of the address

string

3.8. Alert

Alert message

Name Description Schema

level
optional

Level of the alert
Example : "ERROR"

enum (ERROR, WARNING, INFO)

message
optional

Message of the alert
Example : "Lorem ipsum"

string

3.9. AnalysisResult

AnalysisResult

Name Schema

date
optional

string (date-time)

group
optional

< string, object > map

value
optional

number (double)

3.10. ApplicationControlBase

Application control

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

info1
optional

string

info2
optional

string

info3
optional

string

info4
optional

string

info5
optional

string

3.11. Assignment

Assignment

Polymorphism : Composition

Name Description Schema

customer
optional

Details about the customer

CustomerBase

customerId
optional

Ident of the customer
Example : "8900012"

string

phase
optional

Details about the phase

PhaseBase

phaseId
optional

Ident of the phase
Example : "2102047"

string

project
optional

Details about the project

ProjectBase

projectId
optional

Ident of the project
Example : "2101023"

string

projectTask
optional

Details about the task

ProjectTaskBase

projectTaskId
optional

Ident of the project
Example : "2104002"

string

subPhase
optional

Details about the sub-phase

SubPhaseBase

subPhaseId
optional

Ident of the sub-phase
Example : "2103061"

string

3.12. AssignmentCriteria

Criteria used to get more details about an assignment

Name Description Schema

activityId
optional

Ident of the activity

ClauseString

allCompanies
optional

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

boolean

companyId
optional

Ident of the company

ClauseString

countAssignmentType
optional

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

AssignmentType

customerId
optional

Ident of the customer

ClauseString

departmentId
optional

Ident of the department

ClauseString

divisionGroupId
optional

Ident of the division group

ClauseString

divisionId
optional

Ident of the division

ClauseString

employeeId
optional

Ident of the employee

string

employeeIdScheduled
optional

Idents of employees for which the project has schedules

< string > array

employeePartitioning
optional

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

boolean

entityId
optional

Ident of the entity

ClauseString

ignoreProjectAllCustomer
optional

Set as True if you want to ignore all customer projects

boolean

lowerAssignmentType
optional

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.

AssignmentType

phaseCode
optional

Code of the phase

ClauseString

phaseId
optional

Ident of the phase

ClauseString

projectCategorieId
optional

Ident of the project category

ClauseString

projectClosed
optional

Set as True if you want to include closed projects

ClauseBoolean

projectEmployeeLinkedId
optional

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

ClauseString

projectGroupCode
optional

Code of the project group

ClauseString

projectId
optional

Ident of the project

ClauseString

projectInternal
optional

Set as True if you want to include internal projects

ClauseBoolean

projectManagerId
optional

Ident of the project manager

ClauseString

projectOnLeave
optional

Set as True if you want to include leave projects

ClauseBoolean

projectProductionManagerId
optional

Ident of the project production manager

ClauseString

projectSubCategorieId
optional

Ident of the sub-category

ClauseString

projectSubcategorieLevel2Id
optional

Ident of the sub-category level 2

ClauseString

projectTaskEmployeeLinkedId
optional

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

ClauseString

projectTaskId
optional

Ident of the task

ClauseString

referentialDate
optional

Start referential date. If the field is not filled in, it take today’s date by default

string (date-time)

referentialDateEnd
optional

End referential date. This date must be after the referentialDate.

string (date-time)

subPhaseCode
optional

Code of the sub-phase

ClauseString

subPhaseId
optional

Ident of the sub-phase

ClauseString

tag
optional

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

ClauseString

upperAssignmentType
optional

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

AssignmentType

3.13. AssignmentNode

Assignment

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

additionalProperties
optional

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

< string, string > map

assignments
optional

Assignment node’s child

< AssignmentNode > array

code
optional

Code of the assignment
Example : "01-MAINT"

string

description
optional

Short description of the assignment
Example : "Short lorem ipsum"

string

id
required

Id in database

string

longDescription
optional

Long description of the assignment
Example : "Long lorem ipsum"

string

parentId
optional

Ident of the parent
Example : "120047"

string

parentType
optional

Details about the parent

AssignmentType

selectable
optional

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

boolean

type
optional

Details about the assignment type

AssignmentType

3.14. AssignmentReferential

Assignment referential

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

activity
optional

Details about the activity

Activity

category
optional

Details about the category

Category

company
optional

Details about the company

CompanyBase

customer
optional

Details about the customer

CustomerBase

department
optional

Details about the departement

Department

division
optional

Details about the divison

Division

divisionGroup
optional

Details about the division grouping

DivisionGrouping

entity
optional

Details about the entity

Entity

id
required

Id in database

string

phase
optional

Details about the phase

PhaseBase

project
optional

Details about the project

ProjectCommon

projectGroupCode
optional

Details about the code of the project group
Example : "GR1"

string

projectManager
optional

Details about the project manager

EmployeeBase

projectProductionManager
optional

Details about the production manager

EmployeeBase

projectTask
optional

Details about the task

ProjectTaskBase

subCategory
optional

Details about the sub-category

Category

subCategoryLevel2
optional

Details about the second sub-category

Category

subPhase
optional

Details about the sub-phase

SubPhaseBase

3.15. AssignmentSubType

Subtype of Assignment

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

3.16. AssignmentType

Type of Assignment

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

3.17. Avatar

Entity avatar

Name Schema

content
optional

string

3.18. AxeCriteria

AxeCriteria

Name Schema

axeType
required

string

customerAccountManagerId
optional

ClauseString

customerAccountManagerSupervisorId
optional

ClauseString

customerCountryId
optional

ClauseString

customerFamilyId
optional

ClauseString

customerGrouping1
optional

ClauseString

customerGrouping2
optional

ClauseString

customerId
optional

ClauseString

customerRegionId
optional

ClauseString

customerSalesmanId
optional

ClauseString

customerSalesmanSupervisorId
optional

ClauseString

customerSectorId
optional

ClauseString

customerState
optional

ClauseString

customerSubFamilyId
optional

ClauseString

groupCustomer
optional

ClauseBoolean

phaseId
optional

ClauseString

projectActivityId
optional

ClauseString

projectCampaignId
optional

ClauseString

projectCompanyCode
optional

ClauseString

projectDepartmentId
optional

ClauseString

projectDivisionGroupId
optional

ClauseString

projectDivisionId
optional

ClauseString

projectEstablishmentId
optional

ClauseString

projectFamilyId
optional

ClauseString

projectFinancialManagerId
optional

ClauseString

projectId
optional

ClauseString

projectManagerId
optional

ClauseString

projectMarketId
optional

ClauseString

projectProductionManagerId
optional

ClauseString

projectSalesManagerId
optional

ClauseString

projectState
optional

ClauseString

projectSubFamily2Id
optional

ClauseString

projectSubFamilyId
optional

ClauseString

projectVintageId
optional

ClauseString

prospect
optional

ClauseBoolean

subPhaseId
optional

ClauseString

3.19. AxeGroups

AxeGroups

Type : < AxeGroupsType > array

3.20. AxeGroupsType

AxeGroupsType

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.21. BillingMode

State of the Approval (Etat de l’approbation)

Type : enum (TIME_BASED, FIXED_PRICE, RECURRENT)

3.22. BusinessDocument

businessDocument (pièce de gestion)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Details about payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Projected approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

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

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.23. BusinessDocumentLine

BusinessDocumentLine (ligne de pièce de gestion)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

3.24. BusinessDocumentSalesLine

BusinessDocumentSalesLine (ligne de pièce de gestion vente)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00+200"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectTask
optional

Details about the project task.

ProjectTaskBase

projectTaskId
optional

Id of the project task
Example : "5423001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.25. BusinessDocumentType

Type of the business document

Type : enum (QUOTATION, SALES_ORDER, QUOTE, PURCHASE_ORDER, CUSTOM_REQUEST, PURCHASE_INVOICE, EXPENSE_REPORT, INVOICE, SALES_BILLING_TABLE, PURCHASE_BILLING_TABLE, RECEPTION)

3.26. BusinessReferential

businessReferential

Polymorphism : Composition

Name Description Schema

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

3.27. Calendar

Calendar

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

daysNotWorked
optional

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

< integer (int32) > array

default
optional

boolean

holidays
optional

< Holiday > array

id
required

Id in database

string

name
optional

string

3.28. CalendarEvent

CalendarEvent

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

Details about the action verb

ActionCode

actionCodeId
optional

Ident of the action code
Example : "130012"

string

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment of the calendar event

string

customer
optional

Details about the customer

CustomerBase

customerId
optional

Ident of the customer
Example : "8900012"

string

date
optional

Date of the calendar event
Example : "2020-12-07T08:10:10+200"

string (date-time)

duration
optional

Duration of the calendar event
Example : 2.0

number (double)

employee
optional

Details about the employee

EmployeeBase

employeeId
optional

Ident of the employee
Example : "5100160"

string

guid
optional

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

string

id
required

Id in database

string

phase
optional

Details about the phase

PhaseBase

phaseId
optional

Ident of the phase
Example : "2102047"

string

place
optional

Place of the calendar event
Example : "Paris"

string

project
optional

Details about the project

ProjectBase

projectId
optional

Ident of the project
Example : "2101023"

string

projectTask
optional

Details about the task

ProjectTaskBase

projectTaskId
optional

Ident of the project
Example : "2104002"

string

subPhase
optional

Details about the sub-phase

SubPhaseBase

subPhaseId
optional

Ident of the sub-phase
Example : "2103061"

string

type
required

Type of the calendar event
Example : "SCHEDULE"

string

unit
optional

Details about the unit of duration

UnitDuration

validated
optional

Return True if the calendar event is validated

boolean

3.29. Category

Category

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

type
optional

Type of the category.

CategoryType

3.30. CategoryCriteria

Criteria used on Category when doing a Category search

Name Description Schema

code
optional

Code of the category

ClauseString

endDate
optional

End date of validity for the category

ClauseString

id
optional

Ident of the category

ClauseString

name
optional

Name of the category

ClauseString

type
optional

Type of the category

ClauseString

3.31. 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, RETAILER, OTHER_THIRDPARTIES, WORKGROUP, VERSION, CUSTOMERS_CONTRACTS, RETAILER_CONTRACTS, DOCUMENT, TRAINING_ITEM)

3.32. ChangeTracking

History of all changes made

Name Description Schema

createdBy
optional

Code of the creator (user)

UserBase

createdById
optional

Id of the creator (user)
Example : "510034"

string

createdTime
optional

Creation Date
Example : "2020-08-19T08:10:10+200"

string (date-time)

modificationBy
optional

Code of the user who did the modification

UserBase

modificationById
optional

Id of the user who did the modification
Example : "510034"

string

modificationTime
optional

Date of the modification.
Example : "2020-10-29T08:10:10+200"

string (date-time)

3.33. Clause

Basic clause type

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

object

3.34. ClauseBoolean

Boolean clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

The value you search.
Example : true

boolean

3.35. ClauseDate

String clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

The value you search.
Example : "2042-10-29T08:10:10+200"

string (date-time)

3.36. ClauseDouble

Double clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

The value you search.
Example : 12.6

number

3.37. ClauseOperation

Operation used by the clause

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

3.38. ClauseString

String clause type

Polymorphism : Inheritance
Discriminator : operator

Name Description Schema

operator
required

The operator for your operation.

ClauseOperation

value
required

The value you search.
Example : "Customer"

string

3.39. ColorCodes

ColorCodes

Name Schema

color1
optional

string

color2
optional

string

color3
optional

string

3.40. Command

Command

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

endDate
optional

string (date-time)

error
optional

string

id
required

Id in database

string

progress
optional

CommandProgress

result
optional

string

startDate
optional

string (date-time)

status
optional

enum (STARTED, NOT_STARTED, FINISHED, UNKNOWN, ERROR)

3.41. CommandProgress

Command progress status

Name Schema

current
optional

integer

max
optional

integer

3.42. Company

Company (Société)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

calendar
optional

Calendar

calendarId
optional

string

code
optional

Code of the company
Example : "AK"

string

color
optional

string

id
required

Id in database

string

legalName
optional

string

name
optional

Name of the company
Example : "Akuiteo"

string

3.43. CompanyBase

Company

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the company
Example : "AK"

string

id
required

Id in database

string

name
optional

Name of the company
Example : "Akuiteo"

string

3.44. ContactBase

contact

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

firstName
optional

string

id
required

Id in database

string

name
optional

string

3.45. Contract

Contract (contrat)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

endDate
optional

string (date-time)

id
required

Id in database

string

name
optional

string

phaseId
optional

string

projectId
optional

string

reminderAlert
optional

string

reminderDetail
optional

string

subPhaseId
optional

string

terminationDate
optional

string (date-time)

3.46. ContractService

ContractService (prestation)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

contract
optional

Contract

contractId
optional

string

criticalityId
optional

string

id
required

Id in database

string

issueTypeId
optional

string

name
optional

string

phaseId
optional

string

priorityId
optional

string

projectId
optional

string

regression
optional

boolean

reminderAlert
optional

string

reminderDetail
optional

string

severityId
optional

string

subPhaseId
optional

string

teamId
optional

string

3.47. ControlBehavior

Field control behavior

Name Description Schema

defaultValue
optional

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

object

enabled
optional

Return true if the field is enabled
Example : true

boolean

property
optional

Name of the property controlled
Example : "Kilometers"

string

required
optional

Return true if the field is required
Example : true

boolean

visible
optional

Return true if the field is visible
Example : true

boolean

3.48. Currency

Currency

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the currency
Example : "EUR"

string

endDate
optional

End date for using the currency
Example : "2022-12-31T08:10:10+200"

string (date-time)

euro
optional

Returns true if the currency is in euro
Example : true

boolean

euroRate
optional

Euro exchange rate
Example : 0.9678

number (double)

id
required

Id in database

string

name
optional

Name of the currency
Example : "Euro"

string

order
optional

order number of the currency
Example : 17

integer

3.49. CustomField

Custom data

Name Description Schema

name
optional

Name of the custom data
Example : "Reference 4"

string

type
optional

Type of the custom data

CustomFieldType

value
optional

Value of the custom data
Example : "Autoref 010520"

object

3.50. CustomFieldParam

Description of a parameter of custom field

Name Schema

id
optional

string

keywordId
optional

string

multiLine
optional

boolean

name
optional

string

order
optional

integer (int32)

pattern
optional

CustomFieldPattern

property
optional

string

realOrder
optional

integer (int32)

sequence
optional

integer (int32)

textLimit
optional

integer (int32)

type
optional

CustomFieldType

3.51. CustomFieldPattern

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.52. CustomFieldType

Type of the CustomField

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

3.53. CustomerBase

Customers

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the customer
Example : "CUST_001"

string

id
required

Id in database

string

name
optional

Name of the customer
Example : "Customer number 1"

string

3.54. CustomerSiteBase

Customer Sites

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

customerId
optional

Code of the associated customer
Example : "CUST_001"

string

id
required

Id in database

string

name
optional

Name of the customer site
Example : "Paris"

string

3.55. CustomizableResources

Customizable resources (Ressources personnalisables)

Type : enum (ISSUE, OPPORTUNITY, OPPORTUNITY_LINE, CUSTOM_REQUEST, EVENT)

3.56. DateParamHolder

Date given in parameter

Name Description Schema

date
optional

Date
Example : "2013-10-02T08:10:10+200"

string (date-time)

3.57. DayMoment

The moment in a day.

Type : enum (MORNING, AFTERNOON)

3.58. Department

Division

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the department
Example : "01-A"

string

companyCode
optional

Code of the company
Example : "AKSAS"

string

id
required

Id in database

string

name
optional

Description of the department
Example : "Lorem Ipsum"

string

3.59. Describable

Describable interface

Name Schema

description
optional

string

externalReport
optional

string

number
optional

string

title
optional

string

3.60. Division

Division

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a division
Example : "RA"

string

id
required

Id in database

string

name
optional

Name of a division
Example : "Rhone-Alpes"

string

serviceId
optional

Ident of the service
Example : "140012"

string

3.61. DivisionGrouping

Division grouping

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a division grouping
Example : "WST"

string

id
required

Id in database

string

name
optional

Name of a division grouping
Example : "West"

string

serviceId
optional

Ident of the service
Example : "140012"

string

3.62. Document

Details about document (file or link)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

Details about the action performed on the document

Action

category1
optional

First category of the document
Example : "CAT1"

string

category2
optional

Second category of the document
Example : "CAT2"

string

category3
optional

Third category of the document
Example : "CAT3"

string

changeTracking
optional

Creation and modification date and user

ChangeTracking

classification
optional

Classification of the document
Example : "/"

string

companyId
optional

Ident of the company
Example : "1"

string

createdBy
optional

Details about the creator of the document

UserBase

createdById
optional

Ident of the creator of the document
Example : "5001206"

string

creationDate
optional

Creation date of the document
Example : "2021-05-06T17:30:10.130+0200"

string (date-time)

documentType
optional

Type of the document
Example : "File"

string

externalDMSUuid
optional

External ID when you use a DMS
Example : "OD1245126"

string

fileName
optional

File name
Example : "thisFile.pdf"

string

fileUrl
optional

File url
Example : "myFiles/thisFile.pdf"

string

id
required

Id in database

string

lienUrl
optional

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

string

links
optional

Details about document’s links

< DocumentLink > array

original
optional

Return true if the document is an original
Example : false

boolean

preview
optional

Preview of the document
Example : "data:image"

string

publicationDate
optional

Publication date
Example : "2021-05-06T17:30:10.130+0200"

string (date-time)

publishedBy
optional

Details about the publisher of the document.

UserBase

publishedById
optional

Ident of the publisher of the document.
Example : "5001206"

string

sysName
optional

File name
Example : "thisFile.pdf"

string

title
optional

Title of the document
Example : "Title"

string

tokenPreview
optional

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

string

url
optional

URL of the document
Example : "myFiles/thisFile.pdf"

string

version
optional

Version of the document
Example : 1.0

number (double)

versionId
optional

Ident of the version
Example : "500105305"

string

3.63. DocumentLink

a link between a document and any other object

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

document
optional

Details about the document

Document

documentId
optional

Ident of the document
Example : "78922045"

string

id
required

Id in database

string

objectId
optional

Ident of the object linked to the document
Example : "4100365"

string

objectType
optional

Details about the type of object linked

LinkedObjectType

original
optional

Return true if the document is an original
Example : true

boolean

3.64. DocumentVersion

DocumentVersion

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

classification
optional

string

id
required

Id in database

string

title
optional

string

3.65. DueDate

Due date

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amount
optional

Amount to pay
Example : 5423.0

number (double)

currencyCode
optional

Code of the currency
Example : "EUR"

string

date
optional

Due date
Example : "2021-12-31T00:00:00+200"

string (date-time)

id
required

Id in database

string

invoiceId
optional

Ident of the invoice
Example : "670004552"

string

3.66. DueDateCriteria

Criteria used to get more details about the due date

Name Description Schema

invoiceId
optional

Ident of the invoice

ClauseString

3.67. DutiableLine

Tax Line

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.68. EmployeeBase

Employees

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

The action verb.

Action

code
optional

Code of the employee
Example : "CASH"

string

firstName
optional

First name of the employee
Example : "Jean"

string

id
required

Id in database

string

name
optional

Name of the employee
Example : "DUPONT"

string

3.69. Entity

Entity

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the entity
Example : "01-BRDX"

string

companyId
optional

Ident of the company
Example : "170005"

string

divisionId
optional

Ident of the division
Example : "140027"

string

id
required

Id in database

string

legalName
optional

Legal name of the entity
Example : "Customer care"

string

name
optional

The name of the entity
Example : "Bordeaux"

string

3.70. EntityBase

Entity

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The code of the entity
Example : "01-BRDX"

string

id
required

Id in database

string

name
optional

The name of the entity
Example : "Bordeaux"

string

3.71. EventType

Type of event

Type : enum (COMMAND_TASK, COMPANY, CUSTOMER, SUPPLIER, DIVISION, DIVISION_GROUP, EMPLOYEE, EMPLOYEE_HISTORY, ENTITY, EXPENSE, EXPENSE_REPORTS, INVOICES_CHECK, ISSUE, PHASE, PROJECT, PROJECT_TASK, SCHEDULE, SPRINT, SUB_PHASE, TASK, TIMERECORDING, DOCUMENT, YEAR, TITLE, FAMILY, SKILL, SERVICE, JOB_TYPE, MODEL_WEEK, EXPENSE_PROFILE, LANGUAGE, PROJECT_OPTIONS, PROJECT_GROUP, ACTIVITY, DEPARTMENT, REFRESH_CQRS, ALL)

3.72. ExchangeRate

Exchange Rate

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

currency
optional

Details about the currency

Currency

currencyId
optional

Id of the currency
Example : "12006"

string

endDate
optional

End date for using the exchange rate
Example : "2022-12-31T08:10:10+200"

string (date-time)

id
required

Id in database

string

rate
optional

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

number (double)

startDate
optional

Start date for using the exchange rate
Example : "2022-12-31T08:10:10+200"

string (date-time)

3.73. ExpenseReceiptSummary

Details about the expense receipt

Name Description Schema

amount
optional

Amount on the receipt
Example : 240.0

number (double)

currencyCode
optional

Code of the currency
Example : "EUR"

string

date
optional

Date of the document
Example : "2020-10-29T08:10:10+200"

string (date-time)

expenseTypeCode
optional

Code of expense’s type
Example : "FC"

string

filePath
optional

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

string

3.74. ForcedVatAmountHolder

VAT Amount and forced indicator holder

Name Description Schema

amount
optional

Forced amount
Example : 124.56

number (double)

businessDocumentLineId
optional

ID of the business document line
Example : "780023"

string

forced
required

Returns true if the amount is forced
Example : true

boolean

3.75. FormConfig

Form Config

Name Description Schema

deletable
optional

Return true if the schedule can be deleted
Example : false

boolean

editable
optional

Return true if the schedule can be edited
Example : false

boolean

fields
optional

Details about the control behavior linked to the field

< ControlBehavior > array

insertable
optional

Return true if the schedule can be inserted
Example : true

boolean

3.76. Holiday

Holiday

Name Description Schema

date
optional

Date of the holiday
Example : "2020-12-21T00:00:00+200"

string (date-time)

type
optional

Type of holiday
Example : "FERIE"

string

3.77. IdIdentifiable

Basic type for all pojos with an API ID

Name Description Schema

id
required

Id in database

string

3.78. Invoice

Invoice

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

customer
optional

All the information needed about the customer

CustomerBase

customerId
optional

Id of the customer

string

customerToBill
optional

All the information needed about the customer to bill

CustomerBase

customerToBillId
optional

Id of the customer to bill

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

lines
optional

List of the invoice’s lines with their details

< InvoiceLine > array

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Details about payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Projected approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

reference1
optional

Customer reference 1
Example : "CUST_REF_1"

string

reference2
optional

Customer reference 2
Example : "CUST_REF_2"

string

reference3
optional

Customer reference 3
Example : "CUST_REF_3"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

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

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.79. InvoiceCriteria

Search criteria for invoices

Name Description Schema

id
optional

Ident of the invoices

ClauseString

readOptions
optional

Options for retrieving extra information concerning the invoice

InvoiceReadOption

3.80. InvoiceLine

Invoice line

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00+200"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectTask
optional

Details about the project task.

ProjectTaskBase

projectTaskId
optional

Id of the project task
Example : "5423001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.81. InvoiceReadOption

The options you can use to get more information about the invoice.

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (CHANGE_TRACKING, CUSTOMER, CURRENCY, PAYMENT, MANAGER, PROJECT, PHASE, SUB_PHASE, LINE, LINE_PROJECT, LINE_PHASE, LINE_SUB_PHASE, LINE_ITEM, LINE_ITEM_CATEGORY, LINE_ITEM_SUBCATEGORY) > array

type
required

string

3.82. Item

Item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

All details about the category of the sold product

Category

categoryId
optional

The Id of the category
Example : "10024"

string

comment
optional

Comment on the sold product
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

entityCode
optional

The entity code
Example : "Lyon"

string

family
optional

The category of the sold product
Example : "FML-LICENCE"

string

grouping
optional

The grouping of the sold product
Example : "LICENCE"

string

id
required

Id in database

string

inventory
optional

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

boolean

name
optional

Identification name
Example : "Maintenance"

string

reference
optional

The reference of the sold product
Example : "ENGLISH"

string

shortName
optional

Abbreviated designation
Example : "Maint"

string

subCategory
optional

All details about the sub-category of the sold product

SubCategoryItem

subCategoryId
optional

The Id of the sub-category
Example : "11037"

string

subFamily
optional

The sub-category of the sold product
Example : "RECCURENT"

string

3.83. ItemBase

Item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

3.84. ItemLine

ItemLine

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00+200"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.85. JournalType

Type of journal

Type : enum (SALES, PURCHASE, BANK)

3.86. LineTitle

Title line

Name Description Schema

lineTitleId
optional

Id of the title line
Example : 562001.0

number (double)

lineTitleLabel
optional

Label of the title line
Example : "Maintenance"

string

parentLineTitleId
optional

Id of the parent title line
Example : 575003.0

number (double)

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

3.88. Mail

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

Name Description Schema

body
optional

content of the mail as a text

string

cc
optional

Mail carbon copy recipients

< string > array

cci
optional

Mail hidden carbon copy recipients

< string > array

from
optional

Mail sender

string

replyTo
optional

Mail reply to

string

title
optional

Mail title

string

to
optional

Mail recipients

< string > array

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

Name Description Schema

ccRecipients
optional

Mail recipients

< MessageRecipient > array

cciRecipients
optional

Mail recipients

< MessageRecipient > array

mail
optional

Mail

replyTo
optional

Mail recipient replyTo

MessageRecipient

toRecipients
optional

Mail recipients

< MessageRecipient > array

3.90. MessageRecipient

Recipient of a message

Name Schema

address
optional

string

id
optional

string

summary
optional

string

type
optional

MessageRecipientType

3.91. MessageRecipientType

Message recipient type

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

3.92. ObjectsToDeliveryTimeBasedBilling

The parameters for time-based billing

Name Description Schema

deliveryDate
optional

Delivery date
Example : "2021-03-05T08:10:10+200"

string (date-time)

expenseIds
optional

Id of the expenses to bill
Example : [ 10002, 10003, 10004 ]

< string > array

expensesComplementName
optional

Return true if the number of days, the employee code and the amount should be added to the label
Example : true

boolean

groupTimesAndExpenses
optional

Returns true if the time recordings and expenses should be grouped
Example : true

boolean

invoiceDate
optional

Date of the invoice(s) which will be created
Example : "2021-03-05T08:10:10+200"

string (date-time)

lines
optional

Details about orders to be billed

< OrderToDeliveryTimeBasedBilling > array

temporaryBilling
optional

Return True if the delivery should be billed
Example : true

boolean

timesComplementName
optional

Return true if the number of days and the employee code should be added to the label
Example : true

boolean

3.93. OpportunityBase

OpportunityBase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

id
required

Id in database

string

name
optional

string

3.94. OrderToDelivery

Details of an order line for billing

Name Description Schema

orderId
optional

Id of the order
Example : "130056"

string

orderLineId
required

Id of the order’s line
Example : "1010024"

string

quantity
optional

Quantity
Example : 2.0

number (double)

3.95. OrderToDeliveryTimeBasedBilling

Details of an order line for time-based billing

Polymorphism : Inheritance
Discriminator : orderLineId

Name Description Schema

orderId
optional

Id of the order
Example : "130056"

string

orderLineId
required

Id of the order’s line
Example : "1010024"

string

quantity
optional

Quantity
Example : 2.0

number (double)

timeRecordingIds
optional

Id of the time recording linked to the order

< string > array

3.96. PatchElement

A JSONPatch as defined by RFC 6902

Name Description Schema

from
required

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

string

op
required

The operation to be performed

enum (ADD, REMOVE, REPLACE, TEST, MOVE, COPY)

path
required

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

string

value
optional

The value to be used within the operations.

object

3.97. Payment

Payment

Polymorphism : Composition

Name Description Schema

code
optional

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

string

day
optional

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

number (double)

deadLine
optional

Number of days to carry out the payment
Example : "5"

string

term
optional

Period of payment
Example : "End of month"

string

3.98. Period

Period

Name Description Schema

from
optional

smaller date of the period

string (date-time)

granularity
optional

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

PeriodGranularity

inclusivity
optional

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.

string

to
optional

bigger date of the period

string (date-time)

3.99. PeriodGranularity

Granularity of a period

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

3.100. Periodicity

Periodicity

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Periodicity of payment (0 = Unique (default); 1 = Annual; 2 = Bi-annual; 3 = Quarterly; 4 = Monthly)

PeriodicityCodeType

duration
optional

Duration in month
Example : 3.0

number (double)

id
required

Id in database

string

startDate
optional

Date by which the periodicity is starting

string (date-time)

tacitAgrement
optional

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

boolean

term
optional

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

boolean

3.101. PeriodicityCodeType

Type of tag

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

3.102. PhaseBase

Phase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a phase
Example : "PHS_1"

string

id
required

Id in database

string

name
optional

Name of a phase
Example : "Phase 1"

string

order
optional

Order number of the project
Example : 1

integer (int32)

project
optional

Details about the corresponding project

ProjectBase

projectId
optional

Id of the corresponding project
Example : "5100002"

string

3.103. ProjectBase

Project

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

companyCode
optional

Code of the company
Example : "AKSAS"

string

customerId
optional

Id of the customer
Example : "3400012"

string

endCustomerId
optional

Id of the end customer
Example : "3400013"

string

id
required

Id in database

string

internal
optional

If the project is internal or not
Example : false

boolean

leave
optional

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

boolean

leaveType
optional

Details about leave type

ProjectLeaveType

name
optional

Name of a project
Example : "My project"

string

3.104. ProjectCommon

Shared information about projects, accross domains.

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

companyCode
optional

Code of the company
Example : "AKSAS"

string

customerId
optional

Id of the customer
Example : "3400012"

string

endCustomerId
optional

Id of the end customer
Example : "3400013"

string

id
required

Id in database

string

internal
optional

If the project is internal or not
Example : false

boolean

leave
optional

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

boolean

leaveType
optional

Details about leave type

ProjectLeaveType

name
optional

Name of a project
Example : "My project"

string

projectEnd
optional

End date of a project
Example : "2022-03-17T08:10:10+200"

string (date-time)

projectStart
optional

Start date of a project
Example : "2020-10-29T08:10:10+200"

string (date-time)

3.105. ProjectGroup

ProjectGroup

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

string

description
optional

string

id
required

Id in database

string

name
optional

string

3.106. ProjectLeaveType

Type of Project leave

Type : enum (WITH_REQUEST, CALENDAR, NO_TIMERECORDING)

3.107. ProjectTaskBase

The Project task base

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

customer
optional

Details about the customer

CustomerBase

customerId
optional

Ident of the customer
Example : "160023"

string

endDate
optional

End date of the task
Example : "2029-01-15T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

Name of the task
Example : "Team building"

string

order
optional

Order number of the task
Example : 2

integer (int32)

phase
optional

The phase of the project

PhaseBase

phaseId
optional

The ID of the phase
Example : "PH_1"

string

project
optional

The project

ProjectBase

projectId
optional

The ID of a project
Example : "PRJT_1"

string

startDate
optional

Start date of the task
Example : "2020-10-29T08:10:10+200"

string (date-time)

subPhase
optional

The sub-phase of the project

SubPhaseBase

subPhaseId
optional

The ID of the sub-phase
Example : "SB_1"

string

3.108. PublishArguments

Required arguments to publish a document.

Name Description Schema

extension
optional

Document type
Example : ".pdf"

string

parameters
optional

Details about the template parameters

< PublishTemplateParameter > array

saveDocument
optional

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

boolean

template
optional

Details about the template

PublishTemplate

3.109. PublishContextBase

Context for publication, destined for use by specific API

Name Description Schema

contextType
required

Context of the publish
Example : "Time recordings"

string

displayOptions
optional

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

< string, string > map

filters
optional

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

< string, < string > array > map

3.110. PublishTemplate

Details about the template used to publish.

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

The template code
Example : "MODELE_EDITION_001"

string

endDate
optional

End of validity of the template
Example : "2022-12-31T08:10:10+200"

string (date-time)

extensions
optional

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

< string > array

id
required

Id in database

string

name
optional

The template name
Example : "Edition model for my documents"

string

path
optional

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

string

type
optional

Details about the template type

PublishTemplateType

3.111. PublishTemplateParameter

Parameters of a Publish template.

Name Description Schema

controlType
optional

Details about the type of the parameter

PublishTemplateParameterType

groupName
optional

Name of the parameter group
Example : "text_box"

string

labelText
optional

Label of the parameter
Example : "Detail BL"

string

nameField
optional

Name of the parameter
Example : "DetailBL"

string

nameFieldNext
optional

Name of the next parameter
Example : "DetailCheckbox"

string

pattern
optional

Pattern of the parameter
Example : "cl"

string

required
optional

Return true if the paramater is required
Example : true

boolean

selectionList
optional

Details of each value of a LIST_BOX parameter

< PublishTemplateParameterChoice > array

value
optional

Value of the parameter
Example : "checked"

object

3.112. PublishTemplateParameterChoice

If controlType is equal to LIST_BOX, there is a list of each object in the list

Name Description Schema

label
optional

The label
Example : "Bank transfer"

string

value
optional

The value
Example : "BT"

string

3.113. PublishTemplateParameterType

Type of parameter.

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

3.114. PublishTemplateType

Describe the Publish template type which is unique by code-modelId tuple. Allowed ModelId values depend on choosen code value.

Name Description Schema

code
optional

Code of the template type
Example : "TEMP01"

string

modelDescription
optional

Description of the model
Example : "Lorem Ipsum"

string

modelId
optional

Ident of the model
Example : "461225"

string

name
optional

Name of the template type
Example : "Template one"

string

3.115. PublishType

Type of the published document.

Type : enum (QUOTATION, SALES_ORDER, SALES_INVOICE, QUOTE, PURCHASE_ORDER, PURCHASE_INVOICE, CUSTOMER, CUSTOM_REQUEST, EXPENSE_REPORT, EXPENSE_REPORT_LIST, SCHEDULE, TIMERECORDING)

3.116. PublishedDocument

Published Document.

Name Description Schema

documentId
optional

Document ID
Example : "112302"

string

isDocument
optional

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

boolean

token
optional

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

string

3.117. Quotation

Quotation

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournal
optional

Accounting Journal

AccountingJournal

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

contractNumber
optional

Contract Number

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

customFields
optional

The custom data (when present)

< string, CustomField > map

customer
optional

All the information needed about the customer

CustomerBase

customerDate
optional

The customer creation date
Example : "2020-10-29T08:10:10+200"

string (date-time)

customerId
optional

Id of the customer

string

customerToBill
optional

All the information needed about the customer to bill

CustomerBase

customerToBillId
optional

Id of the customer to bill

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

edited
optional

Returns true if the quotation has been edited
Example : true

boolean

entityCode
optional

The entity code
Example : "Lyon"

string

estimatedBillingDate
optional

Estimated Billing Date
Example : "2020-10-29T08:10:10+200"

string (date-time)

estimatedDeliveryDate
optional

Estimated Delivery Date
Example : "2020-10-29T08:10:10+200"

string (date-time)

expectedSignatureDate
optional

The expected signature date
Example : "2020-10-29T08:10:10+200"

string (date-time)

externalNumber
optional

Code of the external software you use.
Example : "Salesforce"

string

id
required

Id in database

string

lineTitleRattachId
optional

Id of the quotation’s first line

number (double)

lines
required

List of the quotation’s lines with their details

< QuotationLine > array

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

notificationDate
optional

Notification date
Example : "2020-10-29T08:10:10+200"

string (date-time)

notified
optional

true if the quotation should be notified

boolean

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Details about payment

Payment

periodicity
optional

Periodicity

Periodicity

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Projected approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

quotationProbability
optional

Probability of the quotation being accepted.

QuotationProbability

reference1
optional

Customer reference 1
Example : "CUST_REF_1"

string

reference2
optional

Customer reference 2
Example : "CUST_REF_2"

string

reference3
optional

Customer reference 3
Example : "CUST_REF_3"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

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

string

titleLines
optional

List of the quotation’s title lines

< LineTitle > array

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

validationDate
optional

Date when the quotation was validated
Example : "2020-10-29T08:10:10+200"

string (date-time)

3.118. QuotationCriteria

Criteria used to get more details about the quotation.

Name Description Schema

id
optional

The Id of the quotation.

ClauseString

readOptions
optional

Options for retrieving extra information concerning the quotation

QuotationReadOption

3.119. QuotationLine

Quotation line

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountDiscount
optional

The discount amount (when specified percentDiscount is not applicable)
Example : 50.0

number (double)

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

contractNumber
optional

The contract number
Example : "CC2017_HDI"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

edited
optional

Returns true if the quotation has been edited
Example : true

boolean

endDate
optional

Period end date
Example : "2020-12-21T00:00:00+200"

string (date-time)

estimatedBillingDate
optional

Estimated date by which the quotation must be billed
Example : "2020-10-29T08:10:10+200"

string (date-time)

estimatedDeliveryDate
optional

The estimated date by which the quotation must be delivered
Example : "2020-10-29T08:10:10+200"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

lineTitleRattachId
optional

Id of the quotation’s title line

number (double)

name
optional

Name of the line
Example : "Helpdesk"

string

notificationDate
optional

Date when the quotation has been notified
Example : "2020-10-29T08:10:10+200"

string (date-time)

percentDiscount
optional

The discount percentage (when specified amountDiscount is not applicable)
Example : "10%"

number (double)

periodicity
optional

Periodicity for recurring billing (0 = Unique(default); 1 = Annuelle; 2 = Semestrielle; 3 = Trimestrielle; 4 = Mensuelle)

Periodicity

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectTask
optional

Details about the project task.

ProjectTaskBase

projectTaskId
optional

Id of the project task
Example : "5423001"

string

projectedBillingDate
optional

The date by which the quotation must be billed
Example : "2020-10-29T08:10:10+200"

string (date-time)

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.120. QuotationProbability

Probability of the quotation being accepted.

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

3.121. QuotationReadOption

The options you can use to get more information about the quotation.

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (MANAGER, CHANGE_TRACKING, CURRENCY, PAYMENT, CUSTOMER, CUSTOMER_TO_BILL, PROJECT, PHASE, SUB_PHASE, LINE, LINE_PROJECT, LINE_PHASE, LINE_SUB_PHASE, LINE_ITEM, LINE_ITEM_CATEGORY, LINE_ITEM_SUBCATEGORY) > array

type
required

string

3.122. ReadOption

option use to get additional information when doing a search

Name Schema

type
required

string

3.123. SalesBusinessDocument

Sales business document

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

customer
optional

All the information needed about the customer

CustomerBase

customerId
optional

Id of the customer

string

customerToBill
optional

All the information needed about the customer to bill

CustomerBase

customerToBillId
optional

Id of the customer to bill

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Details about payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Projected approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

reference1
optional

Customer reference 1
Example : "CUST_REF_1"

string

reference2
optional

Customer reference 2
Example : "CUST_REF_2"

string

reference3
optional

Customer reference 3
Example : "CUST_REF_3"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

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

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.124. SalesOrder

Sales order

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

accountingJournalId
optional

ID of Accounting Journal
Example : "1203"

string

afterTaxAmount
optional

After-Tax Amount
Example : 120.37

number (double)

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

currency
optional

All details about the currency

Currency

currencyCode
optional

Code of the currency used in the document
Example : "EUR"

string

customer
optional

All the information needed about the customer

CustomerBase

customerDate
optional

Date of the client reference
Example : "2021-02-28T00:00:00+200"

string (date-time)

customerId
optional

Id of the customer

string

customerToBill
optional

All the information needed about the customer to bill

CustomerBase

customerToBillId
optional

Id of the customer to bill

string

date
optional

Date on the business document
Example : "2020-11-29T08:10:10+200"

string (date-time)

description
optional

Description
Example : "Lorem ipsum"

string

entityCode
optional

The entity code
Example : "Lyon"

string

id
required

Id in database

string

lines
optional

List of the order’s lines with their details

< SalesOrderLine > array

manager
optional

Manager details

EmployeeBase

managerId
optional

Id of the manager
Example : "500001"

string

name
optional

Name of the business document
Example : "Label for my doc"

string

number
optional

The number of the business document
Example : "CC00001"

string

payment
optional

Details about payment

Payment

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

preTaxAmount
optional

Pre-Tax Amount
Example : 100.14

number (double)

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectedApprovalDate
optional

Projected approval date
Example : "2013-10-02T08:10:10+200"

string (date-time)

reference1
optional

Customer reference 1
Example : "CUST_REF_1"

string

reference2
optional

Customer reference 2
Example : "CUST_REF_2"

string

reference3
optional

Customer reference 3
Example : "CUST_REF_3"

string

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

text
optional

Text on document
Example : "Lorem ipsum"

string

thirdPartyId
optional

The Id of the third-party
Example : "CUSTOMER01"

string

thirdPartyToBillId
optional

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

string

type
optional

Type of the business document
Example: Quotations, Orders, Invoices…

BusinessDocumentType

3.125. SalesOrderCriteria

Criteria used to get more details about the order.

Name Description Schema

companyCode
optional

The company code

ClauseString

currencyId
optional

Id of the currency

ClauseString

customerId
optional

Id of the customer

ClauseString

customerToBillId
optional

Id of the customer to bill

ClauseString

date
optional

Date of creation of the order

ClauseDate

delivered
optional

Return true if the order is delivered
Example : true

boolean

id
optional

The number of the order

ClauseString

readOptions
optional

Options for retrieving additional information about the order

SalesOrderReadOption

salesJournalId
optional

The code of the sales journal

ClauseString

validated
optional

Return true if the order is validated
Example : true

boolean

3.126. SalesOrderDashboardCriteria

Criteria used on sales order dashboard when doing a sales order dashboard search.

Name Description Schema

line
required

Search criteria used on an order line

SalesOrderLineCriteria

salesOrder
required

Search criteria used on an order

SalesOrderCriteria

3.127. SalesOrderDashboardResult

Result of the request /sales/orders/dashboard

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

line
optional

Details about order lines

SalesOrderLine

salesOrder
optional

Details about orders

SalesOrder

3.128. SalesOrderLine

Sales order line

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

amountTotal
optional

Total amount in euro
Example : 1200.0

number (double)

amountTotalCurrency
optional

Total amount in the currency
Example : 1200.0

number (double)

businessDocumentId
optional

Id of the business document

string

complementName
optional

Description of the line
Example : "Lorem ipsum"

string

discount
optional

Total discount amount (on the line) in currency

number (double)

endDate
optional

Period end date
Example : "2020-12-21T00:00:00+200"

string (date-time)

exchangeRate
optional

Details about the exchange rate

ExchangeRate

generalAccount
optional

General Account
Example : "411000"

string

id
required

Id in database

string

item
optional

Details about the item

Item

itemId
optional

The Id of the sold product
Example : "10727"

string

name
optional

Name of the line
Example : "Helpdesk"

string

phase
optional

Details about the phase of the project.

PhaseBase

phaseId
optional

The Id of the phase
Example : "500000123"

string

project
optional

All details about the project

ProjectBase

projectId
optional

The code of the project
Example : "PRJT_001"

string

projectTask
optional

Details about the project task.

ProjectTaskBase

projectTaskId
optional

Id of the project task
Example : "5423001"

string

projectedBillingDate
optional

The date when the order must be billed
Example : "2099-12-31T08:10:10+200"

string (date-time)

quantity
optional

Quantity of the sold product
Example : 3.0

number (double)

rankNumber
optional

Rank number of the line
Example : 2.0

number (double)

startDate
optional

Period start date
Example : "2020-12-21T00:00:00+200"

string (date-time)

subPhase
optional

Details about the sub-phase of the project

SubPhaseBase

subPhaseId
optional

The Id of the sub-phase
Example : "51000122"

string

unitPrice
optional

Unit price of the sold product in euro
Example : 40.0

number (double)

unitPriceCurrency
optional

Unit price of the sold product in the currency
Example : 36.32

number (double)

vat1
optional

Details about the first VAT rate

VATBase

vat2
optional

Details about the second VAT rate

VATBase

vatAmount1
optional

Amount in euro with the first VAT
Example : 120.0

number (double)

vatAmount1Currency
optional

Amount in currency for the first VAT
Example : 126.57

number (double)

vatAmount2
optional

Amount in euro for the second VAT
Example : 110.0

number (double)

vatAmount2Currency
optional

Amount in currency for the second VAT
Example : 113.26

number (double)

3.129. SalesOrderLineCriteria

Criteria used to get more details about order lines.

Name Description Schema

billingMode
optional

Billing mode

ClauseString

categoryId
optional

Id of the category of the sold item

ClauseString

itemId
optional

Id of the sold item

ClauseString

project
optional

Project linked to the order line

SalesProjectCriteria

subCategoryId
optional

Id of the sub-category of the sold item

ClauseString

subCategoryItemType
optional

Type of the sub-category of the sold item

ClauseString

3.130. SalesOrderReadOption

The options you can use to get more information about the order.

Polymorphism : Inheritance
Discriminator : type

Name Schema

options
optional

< enum (MANAGER, CHANGE_TRACKING, CURRENCY, PAYMENT, CUSTOMER, CUSTOMER_TO_BILL, PROJECT, PHASE, SUB_PHASE, LINE, LINE_PROJECT, LINE_PHASE, LINE_SUB_PHASE, LINE_ITEM, LINE_ITEM_CATEGORY, LINE_ITEM_SUBCATEGORY) > array

type
required

string

3.131. SalesProjectCriteria

Criteria used on Project when doing a Project search

Name Description Schema

activityId
optional

ClauseString

categoryId
optional

ClauseString

customerId
optional

ClauseString

customerProjectId
optional

ClauseString

departmentId
optional

ClauseString

divisionGroupingId
optional

ClauseString

divisionId
optional

ClauseString

entityId
optional

ClauseString

financialManagerId
optional

ClauseString

id
optional

ClauseString

managerId
optional

ClauseString

name
optional

ClauseString

productionManagerId
optional

ClauseString

projectGroupCode
optional

ClauseString

projectState
optional

ClauseString

referentialDate
optional

Date à laquelle l’affaire doit être active (en prod)

string (date-time)

salesManagerId
optional

ClauseString

subCategoryId
optional

ClauseString

subCategoryLevel2Id
optional

ClauseString

tag
optional

ClauseString

3.132. ScheduleBase

Schedules

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

Details about the action verb

ActionCode

actionCodeId
optional

Ident of the action code
Example : "130012"

string

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment of the calendar event

string

customer
optional

Details about the customer

CustomerBase

customerId
optional

Ident of the customer
Example : "8900012"

string

date
optional

Date of the calendar event
Example : "2020-12-07T08:10:10+200"

string (date-time)

description
optional

Description of the schedule
Example : "Lorem ipsum"

string

done
optional

Return True if the schedule is done
Example : false

boolean

duration
optional

Duration of the calendar event
Example : 2.0

number (double)

employee
optional

Details about the employee

EmployeeBase

employeeId
optional

Ident of the employee
Example : "5100160"

string

guid
optional

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

string

id
required

Id in database

string

phase
optional

Details about the phase

PhaseBase

phaseId
optional

Ident of the phase
Example : "2102047"

string

place
optional

Place of the calendar event
Example : "Paris"

string

project
optional

Details about the project

ProjectBase

projectId
optional

Ident of the project
Example : "2101023"

string

projectTask
optional

Details about the task

ProjectTaskBase

projectTaskId
optional

Ident of the project
Example : "2104002"

string

subPhase
optional

Details about the sub-phase

SubPhaseBase

subPhaseId
optional

Ident of the sub-phase
Example : "2103061"

string

type
required

Type of the calendar event
Example : "SCHEDULE"

string

unit
optional

Details about the unit of duration

UnitDuration

validated
optional

Return True if the calendar event is validated

boolean

3.133. Service

Service

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the service
Example : "PS"

string

id
required

Id in database

string

name
optional

Name of the service
Example : "Professional services"

string

3.134. Skill

Skill of an employee

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the skill
Example : "ENG"

string

id
required

Id in database

string

name
optional

Name of the skill
Example : "English"

string

typeCode
optional

Code of the skill’s type
Example : "LANGUAGE"

string

typeLabel
optional

Label of the skill’s type
Example : "Language"

string

3.135. SoldItem

Sold item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

All details about the category of the sold product

Category

categoryId
optional

The Id of the category
Example : "10024"

string

comment
optional

Comment on the sold product
Example : "Lorem ipsum"

string

companyCode
optional

The company code
Example : "AKSAS"

string

entityCode
optional

The entity code
Example : "Lyon"

string

family
optional

The category of the sold product
Example : "FML-LICENCE"

string

grouping
optional

The grouping of the sold product
Example : "LICENCE"

string

id
required

Id in database

string

inventory
optional

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

boolean

name
optional

Identification name
Example : "Maintenance"

string

reference
optional

The reference of the sold product
Example : "ENGLISH"

string

shortName
optional

Abbreviated designation
Example : "Maint"

string

subCategory
optional

All details about the sub-category of the sold product

SubCategoryItem

subCategoryId
optional

The Id of the sub-category
Example : "11037"

string

subFamily
optional

The sub-category of the sold product
Example : "RECCURENT"

string

3.136. SoldItemCriteria

Search criteria for sold items

Name Description Schema

id
optional

Ident of the sold item

ClauseString

validity
optional

Details about the validity of the sold item

Validity

3.137. Steppable

Steppable interface

Name Schema

estimate
optional

number (double)

sprintId
optional

string

stepId
optional

string

3.138. SubCategory

Sub-Category

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

Details about the category

Category

categoryId
optional

The Id of the sub-category
Example : "500143"

string

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

type
optional

Type of the category.

CategoryType

3.139. SubCategoryCriteria

Criteria used on sub category when doing a sub category search

Polymorphism : Composition

Name Description Schema

categoryId
optional

ClauseString

code
optional

Code of the category

ClauseString

endDate
optional

End date of validity for the category

ClauseString

id
optional

Ident of the category

ClauseString

name
optional

Name of the category

ClauseString

nature
optional

ClauseString

type
optional

Type of the category

ClauseString

3.140. SubCategoryItem

Sub category of an item

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

category
optional

Details about the category

Category

categoryId
optional

The Id of the sub-category
Example : "500143"

string

code
optional

The code of the category
Example : "LANG"

string

companyCode
optional

The code of the company
Example : "AKSAS"

string

endDate
optional

End date for using the category of the sold product
Example : "2020-10-29T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

The name of the category
Example : "Language"

string

subType
optional

Sub-type of the sub-category item

SubCategoryItemType

type
optional

Type of the category.

CategoryType

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

3.142. SubPhaseBase

SubPhase

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of a sub-phase
Example : "SB_1"

string

id
required

Id in database

string

name
optional

Name of a sub-phase
Example : "Sub Phase 1"

string

order
optional

Order number of the sub-phase
Example : 1

integer (int32)

phase
optional

Details about the corresponding phase

PhaseBase

phaseId
optional

Id of the corresponding phase
Example : "5000123"

string

3.143. Subscription

subscription to listen events using SSE

Name Schema

token
optional

string

topic
optional

Topic

3.144. SupplierBase

Suppliers

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the supplier
Example : "GE"

string

id
required

Id in database

string

name
optional

Name of the supplier
Example : "General Electricity"

string

3.145. SupplierSiteBase

Supplier Site Base (Site Fournisseur)

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

id
required

Id in database

string

name
optional

string

supplierId
optional

string

3.146. Tag

Tag

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the tag
Example : "ERR"

string

color
optional

Color of the tag
Example : "#56b7c"

string

comment
optional

Comment of the tag
Example : "Lorem ipsum"

string

companyId
optional

Ident of the company
Example : "51007"

string

endDate
optional

End of validity of the tag
Example : "2020-10-29T08:10:10+200"

string (date-time)

icon
optional

Icon of the tag
Example : "fa fa-plus"

string

id
required

Id in database

string

name
optional

Name of the tag
Example : "ISSUE"

string

type
optional

Type of the tag

TagType

3.147. TagCriteria

Criteria used when doing a tag search

Name Description Schema

code
optional

Code of the tag

ClauseString

companyId
optional

Ident of the company

ClauseString

id
optional

Ident of the tag

ClauseString

name
optional

Name of the tag

ClauseString

tag
optional

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

ClauseString

type
optional

Type of the tag

ClauseString

validity
optional

Details about validity

Validity

3.148. TagLinked

Tag linked

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

action
optional

Details about the action verb

Action

code
optional

Code of the tag
Example : "ERR"

string

color
optional

Color of the tag
Example : "#56b7c"

string

comment
optional

Comment of the tag
Example : "Lorem ipsum"

string

companyId
optional

Ident of the company
Example : "51007"

string

endDate
optional

End of validity of the tag
Example : "2020-10-29T08:10:10+200"

string (date-time)

icon
optional

Icon of the tag
Example : "fa fa-plus"

string

id
required

Id in database

string

name
optional

Name of the tag
Example : "ISSUE"

string

objectId
optional

Ident of the linked object
Example : "140502"

string

type
optional

Type of the tag

TagType

3.149. TagType

Type of tag

Type : enum (ISSUE, SCHEDULE, OPPORTUNITY)

3.150. TimeRecordingBase

TimeRecordingBase

Polymorphism : Inheritance
Discriminator : type

Name Description Schema

actionCode
optional

Details about the action verb

ActionCode

actionCode2
optional

Details about the second action code

ActionCode2

actionCode2Id
optional

Ident of the second action code
Example : "130013"

string

actionCodeId
optional

Ident of the action code
Example : "130012"

string

approval
optional

Approval of the time recording

enum (BRUT, CONTROLE, VALIDE, GRATUIT, NON_FACTURE, FACTURE, REFUSE, DISSOCIE)

approvalLabel
optional

Label of the approval
Example : "Refused"

string

changeTracking
optional

Date and user in case of creation and modification

ChangeTracking

comment
optional

Comment of the calendar event

string

customer
optional

Details about the customer

CustomerBase

customerId
optional

Ident of the customer
Example : "8900012"

string

date
optional

Date of the calendar event
Example : "2020-12-07T08:10:10+200"

string (date-time)

duration
optional

Duration of the calendar event
Example : 2.0

number (double)

employee
optional

Details about the employee

EmployeeBase

employeeId
optional

Ident of the employee
Example : "5100160"

string

guid
optional

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

string

id
required

Id in database

string

phase
optional

Details about the phase

PhaseBase

phaseId
optional

Ident of the phase
Example : "2102047"

string

place
optional

Place of the calendar event
Example : "Paris"

string

project
optional

Details about the project

ProjectBase

projectId
optional

Ident of the project
Example : "2101023"

string

projectTask
optional

Details about the task

ProjectTaskBase

projectTaskId
optional

Ident of the project
Example : "2104002"

string

subPhase
optional

Details about the sub-phase

SubPhaseBase

subPhaseId
optional

Ident of the sub-phase
Example : "2103061"

string

type
required

Type of the calendar event
Example : "SCHEDULE"

string

unit
optional

Details about the unit of duration

UnitDuration

validated
optional

Return True if the calendar event is validated

boolean

3.151. TitleType

Type of title

Type : enum (UNKNOWN, NEUTRAL, MALE, FEMALE)

3.152. Topic

topic to listen events

Name Schema

action
optional

string

id
optional

string

type
optional

EventType

3.153. UnitDuration

Unit of duration

Type : enum (MINUTE, HOUR_MINUTE, HOUR_DECIMAL, DAY, UNIT_OF_EMPLOYEE)

3.154. UserBase

User

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

Code of the user
Example : "CASH"

string

firstname
optional

First name of the user
Example : "John"

string

id
required

Id in database

string

name
optional

Name of the user
Example : "Doe"

string

3.155. UserCriteria

UserCriteria

Name Schema

id
optional

ClauseString

3.156. VAT

VAT

Polymorphism : Inheritance
Discriminator : id

Name Description Schema

code
optional

VAT code
Example : "7"

string

companyCode
optional

The company code
Example : "AKSAS"

string

endDate
optional

End date of the VAT
Example : "2099-12-31T08:10:10+200"

string (date-time)

id
required

Id in database

string

name
optional

Name
Example : "VAT for capital asset"

string

rate
optional

VAT rate in percentage
Example : "20.0%"

number (double)

reduced
optional

Returns true if the rate is reduced
Example : true

boolean

startDate
optional

Start date of the VAT
Example : "2020-12-31T08:10:10+200"

string (date-time)

3.157. VATBase

VAT

Polymorphism : Composition

Name Description Schema

code
optional

VAT code
Example : "7"

string

rate
optional

VAT rate in percentage
Example : "20.0%"

number (double)

3.158. Validity

Validity criteria

Name Description Schema

date
optional

End date of validity
Example : "2042-10-29T08:10:10+200"

string (date-time)

type
optional

Details about the type of validity.

ValidityType

3.159. ValidityType

Type of validity

Type : enum (VALID, INVALID)

4. Security

4.1. basicAuth

Type : basic

5. Deprecated fields

Definition Field Information

Item View

family

Use category instead

Item View

subFamily

Use subCategory instead

Document View

createdBy

Use changeTracking.createdBy instead

Document View

createdById

Use changeTracking.createdById instead

Document View

creationDate

Use changeTracking.creationDate instead

Document View

sysName

Use fileName instead

6. Lexique multilingue des termes Akuiteo

Anglais Français

year

millésime

* company

société *

account

compte

accounting

comptabilité

accounting export

export comptable

accounting journal

journal comptable

achievement project

affaire de réalisation

action

action

action code

code action

activity

activité

activity report

rapport d’activité

after-tax amount

montant TTC

aging schedule

balance âgée

alert

alerte

allocation

affectation

amortization

amortissement

application control

pilote applicatif

appointment

rendez-vous

approval

approbation

approval type

type d’approbation

approver

approbateur

archived

archivé

arrears

arriéré

Authorization

Autorisation

automatic numbering

numérotation automatique

average daily cost

coût journalier moyen

balance

solde

balance sheet

bilan

bank account details

RIB

bank details

coordonnées bancaires

bank reconciliation

rapprochement bancaire

bank statement

relevé bancaire

bank transfer

virement bancaire

banking

trésorerie (module)

billable

facturable

billed

facturé

billing

facturation

billing table

tableau de facturation

blocking rule

règle de blocage

booked

comptabilisé

Bookmarks

Favoris

budget

budget

budget control

contrôle budgétaire

campaign

campagne

cancel

annuler

canceled

annulé

capital asset

immobilisation

carry forwards

à nouveaux

cash flow

trésorerie

category

famille

charge project

affaire de charge

charging

imputation

chart of accounts (COA)

plan comptable

checkbook

chéquier

checking

pointage

clearing journal

journal de compensation

closing

arrêté

closure

clôture

company

société

complete

terminer

completed

terminé

completion

terminaison

contact

contact

control template

modèle de contrôle

cost

charge

credit

crédit

credit note

avoir

criticality

criticité

CRM

CRM

CRM query

Requêteur CRM

cross-function

transverse

currency

devise

custom control

contrôle paramétrable

custom data

donnée personnalisée

custom request

demande interne

customer

client

Customer Portal

Portail Client

customer to bill

client à facturer

dashboard

tableau de bord

deactivate

désactiver

debit

débit

deferred expenses

CCA (charges constatées d’avance

delete

supprimer

deletion

suppression

delivery

livraison

delivery note

bordereau

dialog box

boîte de dialogue

direct debit

prélèvement bancaire

disbursement

décaissement

discharge

quittance

discount

remise

division

division

division grouping

regroupement de division

DMF

DMF

document

document

Document Management System (DMS)

Gestion électronique des documents (GED)

doubtful customer

client douteux

down payment

acompte

due date

échéance

dunning email

e-mail de relance

dunning letter

lettre de relance

duplicate

dupliquer

Edit

Edition

edit

modifier

employee

collaborateur (salarié)

employee number

matricule (collaborateur)

Employee Portal

Portail Collaborateur

employee schedule

planning collaborateur

entity

établissement

event

événement

event category

catégorie d’événement

exchange rate

taux de change

expense report

note de frais

expense type

nature de dépense

factoring

affacturage

feature

fonction (application)

finances

finances

fiscal year

exercice

follow-up

suivi

GDPR

RGPD

General Setup

Paramétrage Général

group

groupe

grouping

regroupement

Guaranteed Fault Repair Time

GTR

Guaranteed Response Time

GTI

header

en-tête

Helpdesk

Support

history

historique

IDB

TBI

identification

désignation

in progress

en cours

Indicator DashBoard

Tableau de Bord Interactif

info 1

info 1

input

saisie

intercompany

intra-groupe (cross org)

internal account

compte interne

inventory

stock

invoice

facture

issue

demande (support)

journal entry

écriture comptable

label

libellé

labor subleasing

prêt de main d’œuvre

leave request

demande d’absence

leave type

nature d’absence

legal structure

forme juridique

line

ligne

log in

se connecter

log out

se déconnecter

lost opportunity

opportunité perdue

maintained product

produit maintenu

maintenance contract

contrat de maintenance

management

gestion

management object

pièce de gestion

management rule

règle de gestion

manager

responsable

Manager Portal

Portail Manager

mandate

mandat

matching

lettrage

miscellaneous operations

opérations diverses

mission

mission

non-billable

non-facturable

note

note

occupancy rate

taux d’occupation

operating account

compte d’exploitation

opportunity

opportunité

opportunity pipeline

portefeuille d’opportunités

order

commande

order form

bon de commande

owner

propriétaire

paid invoice

facture soldée

partitioning

cloisonnement

payment

règlement

payment authorization

bon à payer

pending

en attente

phase

lot

planned workload

plan de charge

position

fonction (collaborateur)

pre-tax amount

montant HT

print

éditer

product

produit

profitability

rentabilité

project

affaire

project group

marché

project task

tâche

projected billing table

tableau de facturation prévisionnelle

Properties

Propriétés

proposal

proposition

prospect

prospect

purchase

achats

purchase invoice

facture fournisseur

purchase order

commande fournisseur

purchased product

produit acheté

qualification level

niveau d’habilitation

quotation

devis

quote

cotation

rank number

numéro d’ordre

receipt

encaissement

receipt

justificatif

reception

réception

recipient

destinataire

recognized revenue

CA reconnu

reconciliation account

compte collectif

record sheet

fiche

recovery

recouvrement

recurring billing

facturation récurrente

reference

référence

rejected

refusé

renewal

renouvellement

report template

modèle d’édition

required

obligatoire

resolved

résolu

resources

collaborateurs

retention money

retenue de garantie

revenue

chiffre d’affaire

revenue recognition

reconnaissance du CA

sales

ventes

sales contract

contrat client

sales invoice

facture client

sales order

commande client

schedule

planning

scheduled item

élément de planning

screen

écran

search results

résultats de recherche

secondment

détachement

serial number

numéro de série

service

prestation

service

service

setup

paramétrage

severity

gravité

SIA (sales invoice accruals)

FAE (facture à émettre)

signature

signature

simplified issue

demande simplifiée

site

site

skill

compétence

sold product

produit vendu

spending commitment

engagement de dépense

stage

stade

standalone invoice

facture indépendante

standard issue

demande classique

state code

code état

status

statut

status history

historique des situations

sub-category

sous-famille

sub-category level 2

sous-famille 2

subledger account

compte auxiliaire

sub-phase

sous-lot

supplier

fournisseur

supplier employee

fournisseur collaborateur

target

cible

task

intervention

task unit

unité d’intervention

template

modèle

termination

résiliation

Third-party

Tiers

threshold

seuil

time spent

temps passés

time-based billing

facturation en régie

times

temps

Tools

Outils

training

formation

transferred

transféré

trigger

déclencheur

type

nature

unmatching

délettrage

unpaid invoice

facture non soldée

updated projection

reprévision

user

utilisateur

User management

Gestion des utilisateurs

validated

validé

validation

validation

VAT rate

taux de TVA

window

fenêtre

won opportunity

opportunité gagnée

workforce

main d’œuvre

Publication Date: Fri, 26 Apr 2024 05:59:49 GMT
Copyright: Akuiteo © 2024