API Documentation

Responses

Response samples

200
400
401

Content type

application/json

{"id": "28496",
"title": "Society X",
"individual": "0",
"prospect": "0",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this customer",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3345",
"title": "Source d'acquisition",
"value": "5900",
"value_text": "Facebook"
}
],
"opportunities_list": [{"id": "1947",
"pipeline": "1924",
"title": "Opportunity #1",
"archived": "0"
}
],
"sepa_debit_mandat_id": "MANDAT_ID",
"sepa_debit_mandat_date": "15/01/2022",
"sepa_debit_mandat_title": "MANDAT_TITLE",
"sepa_debit_mandat_iban": "IBAN",
"sepa_debit_mandat_bic": "BIC",
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a customer.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

name	string <= 127 characters Name for professional customer or lastname for individual customer
individual	integer Customer type 0 = Professional 1 = Individual
id_civility	integer Customer civility - Only for individual customer 1 = Mr 2 = Ms
firstname	string <= 127 characters Customer firstname - Only for individual customer
prospect	integer Customer status 0 = Client 1 = Prospect
phone	string <= 30 characters Customer phone number
mobile	string <= 30 characters Customer mobile number
email	string <email> <= 127 characters Customer email address
id_client_manager	string Users with group Id associated with the customer For users, email address can be used here
langId	integer Customer language 1 = French 2 = English 3 = Spanish
siret	string <= 30 characters Customer SIRET
siren	integer <= 30 characters Customer SIREN
legal_form	string <= 255 characters Customer status
main_activity	string <= 255 characters APE/NAF code
vat_number	string <= 30 characters VAT number
default_discount_percent	number <double> Default discount
id_document_template	integer Document template Id
id_payment_condition	integer Id of payment condition 0 = Not filled in
id_vat	integer VAT Id -1 = Not filled in
description	string <= 255 characters Customer description
client_number	string <= 30 characters Internal number
	Array of objects Custom fields
main_address	string <= 255 characters Main address
main_zip_code	string <= 64 characters ZIP code of main address
main_city	string <= 127 characters City of main address
main_country	string <= 64 characters Country of main address
delivery_title	string <= 127 characters Name or company name of delivery address
delivery_address	string <= 255 characters Delivery address
delivery_zip_code	string <= 64 characters ZIP code of delivery address
delivery_city	string <= 127 characters City of delivery address
delivery_country	string <= 64 characters Country of delivery address
invoice_title	string <= 127 characters Name or company name of invoice address
invoice_address	string <= 255 characters Invoice address
invoice_zip_code	string <= 64 characters ZIP code of invoice address
invoice_city	string <= 127 characters City of invoice address
invoice_country	string <= 64 characters Country of invoice address
sepa_debit_mandat_id	string SEPA mandat ID (only if SEPA is activated)
sepa_debit_mandat_date	date SEPA mandat date (only if SEPA is activated)
sepa_debit_mandat_title	string SEPA mandat title (only if SEPA is activated)
sepa_debit_mandat_iban	string SEPA mandat IBAN (only if SEPA is activated)
sepa_debit_mandat_bic	string SEPA mandat BIC (only if SEPA is activated)
archived	integer Customer status 0 = Not archived 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"name": "Society X",
"individual": 0,
"id_civility": "",
"firstname": "",
"prospect": 0,
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"id_client_manager": "u213",
"langId": 1,
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"default_discount_percent": 10.5,
"id_document_template": "",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this customer",
"client_number": 123,
"custom_fields": [{"id": 3345,
"value": 5900
}
],
"main_address": "55 Av. Louis Breguet",
"main_zip_code": 31400,
"main_city": "Toulouse",
"main_country": "France",
"delivery_title": "My delivery address",
"delivery_address": "1 place du Capitole",
"delivery_zip_code": 31000,
"delivery_city": "Toulouse",
"delivery_country": "France",
"invoice_title": "My invoice address",
"invoice_address": "55 Rue du Faubourg Saint-Honoré",
"invoice_zip_code": 75000,
"invoice_city": "Paris",
"invoice_country": "France",
"sepa_debit_mandat_id": "MANDAT_ID",
"sepa_debit_mandat_date": "15/01/2022",
"sepa_debit_mandat_title": "MANDAT_TITLE",
"sepa_debit_mandat_iban": "IBAN",
"sepa_debit_mandat_bic": "BIC",
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "28496",
"title": "Society X",
"individual": "0",
"prospect": "0",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this customer",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3345",
"title": "Source d'acquisition",
"value": "5900",
"value_text": "Facebook"
}
],
"opportunities_list": [{"id": "1947",
"pipeline": "1924",
"title": "Opportunity #1",
"archived": "0"
}
],
"sepa_debit_mandat_id": "MANDAT_ID",
"sepa_debit_mandat_date": "15/01/2022",
"sepa_debit_mandat_title": "MANDAT_TITLE",
"sepa_debit_mandat_iban": "IBAN",
"sepa_debit_mandat_bic": "BIC",
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Custom fields

Get a list of all customers custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3346",
"title": "Source of acquisition",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of customers custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Customer custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "5899",
"title": "Facebook"
},
{"id"": "5900",
"title": "Google AdWords"
},
{"id": "5901",
"title": "Website"
}
]
}

Add/Update custom field

Add or update a customer custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Customer Id
field_id required	integer Customer custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 5900
}

Response samples

200
400
401

Content type

application/json

{"id": "28496",
"title": "Society X",
"individual": "0",
"prospect": "0",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this customer",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3345",
"title": "Source d'acquisition",
"value": "5900",
"value_text": "Facebook"
}
],
"opportunities_list": [{"id": "1947",
"pipeline": "1924",
"title": "Opportunity #1",
"archived": "0"
}
],
"sepa_debit_mandat_id": "MANDAT_ID",
"sepa_debit_mandat_date": "15/01/2022",
"sepa_debit_mandat_title": "MANDAT_TITLE",
"sepa_debit_mandat_iban": "IBAN",
"sepa_debit_mandat_bic": "BIC",
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Create

Add a new file for a customer.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

upload_file_content	string Content of the file to upload (base64)
upload_file_url	string URL of the file to upload Do not use URL with protected file which need to be connected to access to the file Used only if upload_file_content is empty or not defined
upload_file_name	string Name of the file

Responses

Request samples

Payload

Content type

application/json

{"upload_file_content": "",
"upload_file_url": "",
"upload_file_name": ""
}

Response samples

200
400
401

Content type

application/json

{"id": "28496",
"title": "Society X",
"individual": "0",
"prospect": "0",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this customer",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3345",
"title": "Source d'acquisition",
"value": "5900",
"value_text": "Facebook"
}
],
"opportunities_list": [{"id": "1947",
"pipeline": "1924",
"title": "Opportunity #1",
"archived": "0"
}
],
"sepa_debit_mandat_id": "MANDAT_ID",
"sepa_debit_mandat_date": "15/01/2022",
"sepa_debit_mandat_title": "MANDAT_TITLE",
"sepa_debit_mandat_iban": "IBAN",
"sepa_debit_mandat_bic": "BIC",
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Delete

Delete a file for a customer.

Authorizations:

Bearer token

path Parameters

id required	integer Customer Id
file_id required	integer File Id

Responses

Response samples

200
400
401

Content type

application/json

null

History

Get customer history.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_user	integer User Id of the user updater
fields	string Updated fields list (separated by a comma)
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"field": "title",
"old_value": "Value 1",
"new_value": "Value 2",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Suppliers

This section lists all supplier-related APIs.

List

Get a list of all suppliers.

Authorizations:

Bearer token

query Parameters

quick_search	string <= 127 characters Quick search field If this field is filled in, the other search fields are not taken into account. The search is then performed in the entire supplier database.
name	integer <= 127 characters Search by name
client_number	string <= 30 characters Search by client number
phone	string <= 30 characters Search by phone number
mobile	string <= 30 characters Search by mobile number
email	string <email> <= 127 characters Search by email
id_client_manager	string Search by user with group associated with the supplier
langId	integer Search by language 1 = French 2 = English 3 = Spanish
siret	string <= 30 characters Search by SIRET
siren	string <= 30 characters Search by SIREN
vat_number	string <= 30 characters Search by VAT number
archived	integer Search by status 0 = Not archived 1 = Archived
creation_date_min	string <date-time> Search by creation date
creation_date_max	string <date-time> Search by creation date
update_date_min	string <date-time> Search by update date
update_date_max	string <date-time> Search by update date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 5,
"limit": 100,
"offset": 0
},
"data": [{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a supplier.

Authorizations:

Bearer token

Request Body schema: application/json

name required	string <= 127 characters Supplier name
phone	string <= 30 characters Supplier phone number
mobile	string <= 30 characters Supplier mobile number
email	string <email> <= 127 characters Supplier email address
id_client_manager	string Users with group Id associated with the supplier For users, email address can be used here
langId	integer Supplier language 1 = French 2 = English 3 = Spanish
siret	string <= 30 characters Supplier SIRET
siren	integer <= 30 characters Supplier SIREN
legal_form	string <= 255 characters Supplier status
main_activity	string <= 255 characters APE/NAF code
vat_number	string <= 30 characters VAT number
id_document_template	integer Document template Id
id_payment_condition	integer Id of payment condition 0 = Not filled in
id_vat	integer VAT Id -1 = Not filled in
description	string <= 255 characters Supplier description
client_number	string <= 30 characters Internal number
	Array of objects Custom fields
main_address	string <= 255 characters Main address
main_zip_code	string <= 64 characters ZIP code of main address
main_city	string <= 127 characters City of main address
main_country	string <= 64 characters Country of main address
delivery_title	string <= 127 characters Name or company name of delivery address
delivery_address	string <= 255 characters Delivery address
delivery_zip_code	string <= 64 characters ZIP code of delivery address
delivery_city	string <= 127 characters City of delivery address
delivery_country	string <= 64 characters Country of delivery address
invoice_title	string <= 127 characters Name or company name of invoice address
invoice_address	string <= 255 characters Invoice address
invoice_zip_code	string <= 64 characters ZIP code of invoice address
invoice_city	string <= 127 characters City of invoice address
invoice_country	string <= 64 characters Country of invoice address
archived	integer Supplier status 0 = Not archived 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"name": "Society Y",
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"id_client_manager": "u213",
"langId": 1,
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_document_template": "",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": 123,
"custom_fields": [{"id": 3352,
"value": 5911
}
],
"main_address": "55 Av. Louis Breguet",
"main_zip_code": 31400,
"main_city": "Toulouse",
"main_country": "France",
"delivery_title": "My delivery address",
"delivery_address": "1 place du Capitole",
"delivery_zip_code": 31000,
"delivery_city": "Toulouse",
"delivery_country": "France",
"invoice_title": "My invoice address",
"invoice_address": "55 Rue du Faubourg Saint-Honoré",
"invoice_zip_code": 75000,
"invoice_city": "Paris",
"invoice_country": "France",
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [ ],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one supplier.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a supplier.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

name	string <= 127 characters Supplier name
phone	string <= 30 characters Supplier phone number
mobile	string <= 30 characters Supplier mobile number
email	string <email> <= 127 characters Supplier email address
id_client_manager	string Users with group Id associated with the supplier For users, email address can be used here
langId	integer Supplier language 1 = French 2 = English 3 = Spanish
siret	string <= 30 characters Supplier SIRET
siren	integer <= 30 characters Supplier SIREN
legal_form	string <= 255 characters Supplier status
main_activity	string <= 255 characters APE/NAF code
vat_number	string <= 30 characters VAT number
id_document_template	integer Document template Id
id_payment_condition	integer Id of payment condition 0 = Not filled in
id_vat	integer VAT Id -1 = Not filled in
description	string <= 255 characters Supplier description
client_number	string <= 30 characters Internal number
	Array of objects Custom fields
main_address	string <= 255 characters Main address
main_zip_code	string <= 64 characters ZIP code of main address
main_city	string <= 127 characters City of main address
main_country	string <= 64 characters Country of main address
delivery_title	string <= 127 characters Name or company name of delivery address
delivery_address	string <= 255 characters Delivery address
delivery_zip_code	string <= 64 characters ZIP code of delivery address
delivery_city	string <= 127 characters City of delivery address
delivery_country	string <= 64 characters Country of delivery address
invoice_title	string <= 127 characters Name or company name of invoice address
invoice_address	string <= 255 characters Invoice address
invoice_zip_code	string <= 64 characters ZIP code of invoice address
invoice_city	string <= 127 characters City of invoice address
invoice_country	string <= 64 characters Country of invoice address
archived	integer Supplier status 0 = Not archived 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"name": "Society Y",
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"id_client_manager": "u213",
"langId": 1,
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_document_template": "",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": 123,
"custom_fields": [{"id": 3352,
"value": 5911
}
],
"main_address": "55 Av. Louis Breguet",
"main_zip_code": 31400,
"main_city": "Toulouse",
"main_country": "France",
"delivery_title": "My delivery address",
"delivery_address": "1 place du Capitole",
"delivery_zip_code": 31000,
"delivery_city": "Toulouse",
"delivery_country": "France",
"invoice_title": "My invoice address",
"invoice_address": "55 Rue du Faubourg Saint-Honoré",
"invoice_zip_code": 75000,
"invoice_city": "Paris",
"invoice_country": "France",
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Custom fields

Get a list of all suppliers custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "3352",
"title": "Payment condition",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of suppliers custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Supplier custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "5911",
"title": "30 days"
},
{"id"": "5912",
"title": "45 days end of month"
}
]
}

Add/Update custom field

Add or update a supplier custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Supplier Id
field_id required	integer Supplier custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 5911
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Create

Add a new file for a supplier.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

upload_file_content	string Content of the file to upload (base64)
upload_file_url	string URL of the file to upload Do not use URL with protected file which need to be connected to access to the file Used only if upload_file_content is empty or not defined
upload_file_name	string Name of the file

Responses

Request samples

Payload

Content type

application/json

{"upload_file_content": "",
"upload_file_url": "",
"upload_file_name": ""
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"title": "Society Y",
"id_client_manager": ["u213"
],
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"email": "contact@example.com",
"langId": "1",
"siret": "123 568 941 00056",
"siren": "123 568 941",
"legal_form": "SARL",
"main_activity": "4616C",
"vat_number": "FR 32 123456789",
"id_parent": "0",
"id_products_prices_category": "0",
"id_payment_condition": "0",
"id_vat": "-1",
"description": "A description or note about this supplier",
"client_number": "123",
"address_list": [{"id": "17894",
"type": "main",
"title": "",
"address": "55 Av. Louis Breguet",
"zip_code": "31400",
"city": "Toulouse",
"country": "France",
"latitude": "43.57711972081131",
"longitude": "1.4767491490358602",
"is_default": true
},
{"id": "17895",
"type": "delivery",
"title": "My delivery address",
"address": "1 place du Capitole",
"zip_code": "31000",
"city": "Toulouse",
"country": "France",
"latitude": "43.60394807541591",
"longitude": "1.4442377834043243",
"is_default": false
},
{"id": "17896",
"type": "invoice",
"title": "My invoice address",
"address": "55 Rue du Faubourg Saint-Honoré",
"zip_code": "75000",
"city": "Paris",
"country": "France",
"latitude": "48.87018658507098",
"longitude": "2.3165783971275635",
"is_default": false
}
],
"contacts_list": [{"id": "4700",
"civility": "Mr",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"description": "A description or note about this contact"
}
],
"custom_fields_list": [{"id": "3352",
"title": "Payment condition",
"value": "5911",
"value_text": "30 days"
}
],
"files_list": [{"id": "149",
"name": "FileName",
"extension": "pdf",
"url": "https://karlia.fr/download-link",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
],
"archived": "0",
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Delete

Delete a file for a supplier.

Authorizations:

Bearer token

path Parameters

id required	integer Supplier Id
file_id required	integer File Id

Responses

Response samples

200
400
401

Content type

application/json

null

History

Get supplier history.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_user	integer User Id of the user updater
fields	string Updated fields list (separated by a comma)
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"field": "title",
"old_value": "Value 1",
"new_value": "Value 2",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Contacts

This section lists all contact-related APIs.

List

Get a list of all contacts.

Authorizations:

Bearer token

query Parameters

quick_search	string <= 127 characters Quick search field If this field is filled in, the other search fields are not taken into account. The search is then performed in the entire customer database.
id_customer_supplier	integer <= 127 characters Search by customer Id or supplier Id
id_civility	integer Search by status 1 = Mr 2 = Ms
lastname	string <= 127 characters Search by lastname
firstname	string <= 127 characters Search by firstname
position_title	string <= 127 characters Search by position title
email	string <email> <= 127 characters Search by email
phone	string <= 30 characters Search by phone number
mobile	string <= 30 characters Search by mobile number
is_accounting_contact	integer Search by accounting contact 1 = Yes 0 = No
client_number	string <= 30 characters Search by client number
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"pagination": {"total": 3,
"limit": 100,
"offset": 0
},
"data": [{"id": "48560",
"id_customer_supplier": "28496",
"supplier": "0",
"title": "Mr Jean Dupont",
"id_civility": "1",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"is_accounting_contact": "0",
"description": "A description or note about this contact",
"client_number": "123",
"custom_fields_list": [{"id": "3407",
"title": "Contact type",
"value": "5994",
"value_text": "Decision-maker contact"
}
],
"client_portal": {"status": "1",
"id_right": "5",
"last_connexion": "2023-01-15 15:42:35",
"password_last_update": "2022-12-10 10:14:12"
},
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a contact.

Authorizations:

Bearer token

Request Body schema: application/json

id_customer_supplier required	integer Customer Id or supplier Id
id_civility	integer Contact civility 1 = Mr 2 = Ms
lastname required	string <= 127 characters Contact lastname
firstname	string <= 127 characters Contact firstname
position_title	string <= 127 characters Contact position title
email	string <email> <= 127 characters Contact email address
phone	string <= 30 characters Contact phone number
mobile	string <= 30 characters Contact mobile number
is_accounting_contact	integer Is accounting contact 1 = Yes 0 = No
description	string <= 255 characters Contact description
client_number	string <= 30 characters Internal number
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"id_customer_supplier": 28496,
"id_civility": "",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "contact@example.com",
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"is_accounting_contact": 0,
"description": "A description or note about this contact",
"client_number": 123,
"custom_fields": [{"id": 3704,
"value": 5994
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"id_customer_supplier": "28496",
"supplier": "0",
"title": "Mr Jean Dupont",
"id_civility": "1",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"is_accounting_contact": "0",
"description": "A description or note about this contact",
"client_number": "123",
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3407",
"title": "Contact type",
"value": "5994",
"value_text": "Decision-maker contact"
}
],
"client_portal": {"status": "1",
"id_right": "5",
"last_connexion": "2023-01-15 15:42:35",
"password_last_update": "2022-12-10 10:14:12"
},
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one contact.

Authorizations:

Bearer token

path Parameters

id

required

integer

Contact Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"id_customer_supplier": "28496",
"supplier": "0",
"title": "Mr Jean Dupont",
"id_civility": "1",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"is_accounting_contact": "0",
"description": "A description or note about this contact",
"client_number": "123",
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3407",
"title": "Contact type",
"value": "5994",
"value_text": "Decision-maker contact"
}
],
"client_portal": {"status": "1",
"id_right": "5",
"last_connexion": "2023-01-15 15:42:35",
"password_last_update": "2022-12-10 10:14:12"
},
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a contact.

Authorizations:

Bearer token

path Parameters

id

required

integer

Contact Id

Request Body schema: application/json

id_customer_supplier	integer Customer Id or supplier Id
id_civility	integer Contact civility 1 = Mr 2 = Ms
lastname	string <= 127 characters Contact lastname
firstname	string <= 127 characters Contact firstname
position_title	string <= 127 characters Contact position title
email	string <email> <= 127 characters Contact email address
phone	string <= 30 characters Contact phone number
mobile	string <= 30 characters Contact mobile number
is_accounting_contact	integer Is accounting contact 1 = Yes 0 = No
description	string <= 255 characters Contact description
client_number	string <= 30 characters Internal number
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"id_customer_supplier": 28496,
"id_civility": "",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "contact@example.com",
"phone": "+33512345678",
"mobile": "07 98 76 54 32",
"is_accounting_contact": 0,
"description": "A description or note about this contact",
"client_number": 123,
"custom_fields": [{"id": 3704,
"value": 5994
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"id_customer_supplier": "28496",
"supplier": "0",
"title": "Mr Jean Dupont",
"id_civility": "1",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"is_accounting_contact": "0",
"description": "A description or note about this contact",
"client_number": "123",
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3407",
"title": "Contact type",
"value": "5994",
"value_text": "Decision-maker contact"
}
],
"client_portal": {"status": "1",
"id_right": "5",
"last_connexion": "2023-01-15 15:42:35",
"password_last_update": "2022-12-10 10:14:12"
},
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Custom fields

Get a list of all contacts custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3407",
"title": "Contact type",
"type": "Tags (separated by a comma)",
"with_values": "true"
}
]
}

Custom field values

Get values of contacts custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Contact custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "5991",
"title": "Commercial contact"
},
{"id": "5992",
"title": "Accounting contact"
},
{"id": "5993",
"title": "Decision-maker contact"
},
{"id": "5994",
"title": "Delivery contact"
}
]
}

Add/Update custom field

Add or update a contact custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Contact Id
field_id required	integer Contact custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 5994
}

Response samples

200
400
401

Content type

application/json

{"id": "48560",
"id_customer_supplier": "28496",
"supplier": "0",
"title": "Mr Jean Dupont",
"id_civility": "1",
"lastname": "Dupont",
"firstname": "Jean",
"position_title": "CEO",
"email": "jeandupont@example.com",
"phone": "02 45 68 37 98",
"mobile": "06 94 31 81 31",
"is_accounting_contact": "0",
"description": "A description or note about this contact",
"client_number": "123",
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3407",
"title": "Contact type",
"value": "5994",
"value_text": "Decision-maker contact"
}
],
"client_portal": {"status": "1",
"id_right": "5",
"last_connexion": "2023-01-15 15:42:35",
"password_last_update": "2022-12-10 10:14:12"
},
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Opportunities

This section lists all opportunity-related APIS.

List

Get a list of all opportunities.

Authorizations:

Bearer token

query Parameters

pipeline	integer Search by pipeline Id
id_customer	integer Search by customer Id
title	string <= 127 characters Search by title
column_number	integer Search by pipeline column Id
id_user_assigned	string <= 30 characters Search by user with group Id associated with the opportunity
id_status	integer Search by opportunity status Id
id_status_lost	integer Search by reason Id for status loss
id_status_canceled	integer Search by reason Id for status cancellation
archived	integer Search by opportunity condition 0 = Active 1 = Archived
creation_date_min	string <date-time> Search by creation date
creation_date_max	string <date-time> Search by creation date
update_date_min	string <date-time> Search by update date
update_date_max	string <date-time> Search by update date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 3,
"limit": 100,
"offset": 0
},
"data": [{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"opportunity_status": "Open",
"id_status_lost": "0",
"opportunity_status_lost": "",
"id_status_canceled": "0",
"opportunity_status_canceled": "",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"proposals": [{"id": "3413",
"number": "1",
"description": "",
"files_list": [ ]
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create an opportunity.

Authorizations:

Bearer token

Request Body schema: application/json

pipeline required	integer Pipeline Id
id_customer required	integer Customer Id
title	string <= 127 characters Opportunity title
column_number	integer Pipeline column Id
id_user_assigned	string User with group Id associated with the opportunity For users, email address can be used here
id_status	integer Opportunity status Id
id_status_lost	integer <email> Reason Id for status loss. Only if status is lost
id_status_canceled	integer Reason Id for status cancellation. Only if status is cancelled
color	string Opportunity color Hexadecimal value
archived	integer Opportunity status 0 = Active 1 = Archived
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"pipeline": 1934,
"id_customer": 48560,
"title": "Opportunity #1",
"column_number": 1,
"id_user_assigned": "u213",
"id_status": 0,
"id_status_lost": "",
"id_status_canceled": "",
"color": "ff0000",
"archived": 0,
"custom_fields": [{"id": 3413,
"value": 5995
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"id_status_lost": "0",
"id_status_canceled": "0",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one opportunity.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
401

Content type

application/json

{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"opportunity_status": "Open",
"id_status_lost": "0",
"opportunity_status_lost": "",
"id_status_canceled": "0",
"opportunity_status_canceled": "",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"proposals": [{"id": "3413",
"number": "1",
"description": "",
"files_list": [ ]
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update an opportunity.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

pipeline	integer Pipeline Id
id_customer	integer Customer Id
title	string <= 127 characters Opportunity title
column_number	integer Pipeline column Id
id_user_assigned	string User with group Id associated with the opportunity For users, email address can be used here
id_status	integer Opportunity status Id
id_status_lost	integer <email> Reason Id for status loss. Only if status is lost
id_status_canceled	integer Reason Id for status cancellation. Only if status is cancelled
color	string Opportunity color Hexadecimal value
archived	integer Opportunity status 0 = Active 1 = Archived
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"pipeline": 1934,
"id_customer": 48560,
"title": "Opportunity #1",
"column_number": 1,
"id_user_assigned": "u213",
"id_status": 0,
"id_status_lost": "",
"id_status_canceled": "",
"color": "ff0000",
"archived": 0,
"custom_fields": [{"id": 3413,
"value": 5995
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"opportunity_status": "Open",
"id_status_lost": "0",
"opportunity_status_lost": "",
"id_status_canceled": "0",
"opportunity_status_canceled": "",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"proposals": [{"id": "3413",
"number": "1",
"description": "",
"files_list": [ ]
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete an opportunity.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

null

Custom fields

Get a list of all opportunities custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3413",
"title": "Source",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of opportunities custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Opportunity custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "5995",
"title": "Phone"
},
{"id": "5996",
"title": "Website"
}
]
}

Add/Update custom field

Add or update a opportunity custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Opportunity Id
field_id required	integer Opportunity custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 5995
}

Response samples

200
400
401

Content type

application/json

{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"opportunity_status": "Open",
"id_status_lost": "0",
"opportunity_status_lost": "",
"id_status_canceled": "0",
"opportunity_status_canceled": "",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"proposals": [{"id": "3413",
"number": "1",
"description": "",
"files_list": [ ]
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Create

Add a new file for an opportunity.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

id_proposal	integer Id of the proposition in the opportunity 0 = add this file in the last proposal More than 0 = Id of the proposal to add this file -1 or no proposal in this opportunity = create a new proposal to add this file
upload_file_content	string Content of the file to upload (base64)
upload_file_url	string URL of the file to upload Do not use URL with protected file which need to be connected to access to the file Used only if upload_file_content is empty or not defined
upload_file_name	string Name of the file

Responses

Request samples

Payload

Content type

application/json

{"id_proposal": "0",
"upload_file_content": "",
"upload_file_url": "",
"upload_file_name": ""
}

Response samples

200
400
401

Content type

application/json

{"id": "1985",
"pipeline": "1934",
"column_number": "1",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"id_customer": "28496",
"title": "Opportunity #1",
"id_status": "0",
"opportunity_status": "Open",
"id_status_lost": "0",
"opportunity_status_lost": "",
"id_status_canceled": "0",
"opportunity_status_canceled": "",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"color": "#ff0000",
"archived": "0",
"custom_fields_list": [{"id": "3413",
"title": "Source",
"value": "5995",
"value_text": "Website"
}
],
"proposals": [{"id": "3413",
"number": "1",
"description": "",
"files_list": [ ]
}
],
"creation_source": "3",
"creation_source_title": "API",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Files - Delete

Delete a file for an opportunity.

Authorizations:

Bearer token

path Parameters

id required	integer Opportunity Id
file_id required	integer File Id

Responses

Response samples

200
400
401

Content type

application/json

null

Pipelines

Get a list of all opportunities pipelines.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "1934",
"title": "Tableau",
"title_en": "Table",
"title_es": "Cuadro"
}
]
}

Pipelines columns

Get opportunities pipeline columns.

Authorizations:

Bearer token

path Parameters

pipeline_id

required

integer

Pipeline Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "Prospecting",
"probability": "0.00"
},
{"id": "2",
"title": "Proposal",
"probability": "25.00"
},
{"id": "3",
"title": "Negotiation",
"probability": "50.00"
},
{"id": "4",
"title": "Sales",
"probability": "75.00"
}
]
}

Status

Get a list of all status.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "0",
"title": "Open"
},
{"id": "1",
"title": "Won"
},
{"id": "2",
"title": "Lost"
},
{"id": "3",
"title": "Cancelled"
}
]
}

Status lost

Get a list of all lost statuses.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "1090",
"title": "Concurrence",
"title_en": "Competition",
"title_es": "Competencia"
},
{"id": "1091",
"title": "Non qualifié",
"title_en": "Unqualified",
"title_es": "No calificado"
},
{"id": "1092",
"title": "Pas adapté",
"title_en": "Not suitable",
"title_es": "No apto"
},
{"id": "1093",
"title": "Trop cher",
"title_en": "Too expensive",
"title_es": "Demasiado caro"
}
]
}

Status canceled

Get a list of all canceled statuses.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": 0,
"title": "string",
"title_en": "string",
"title_es": "string"
}
]
}

History

Get opportunity history.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_user	integer User Id of the user updater
fields	string Updated fields list (separated by a comma)
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"field": "title",
"old_value": "Value 1",
"new_value": "Value 2",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Documents

This section lists all documents-related APIS.

List

Get a list of all documents.

Authorizations:

Bearer token

query Parameters

from	string <date-time> Search by document date
to	string <date-time> Search by expiration date
type	integer Document type 1 => Quotes 2 => Orders 3 => Deliveries 4 => Invoices
status_not_draft	integer List all the documents not in draft status No expected value, do not use this field if you don't want to list documents not in draft status
id_status	Array of arrays Search by status This field can be used only if status_not_draft is not used
id_customer	integer Search by customer Id
id_user_assigned	string Users with group Id associated with the oportunity
document_number	string <= 30 characters Document number
pipeline	integer Pipeline Id
creation_date_min	string <date-time> Search by creation date
creation_date_max	string <date-time> Search by creation date
update_date_min	string <date-time> Search by update date
update_date_max	string <date-time> Search by update date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "2758",
"id_customer_supplier": "48560",
"customer_supplier_title": "Society X",
"pipeline": "1934",
"id_opportunity": "1985",
"id_type": "1",
"type_text": "Quotes",
"number": "",
"date": "2022-05-16",
"date_end": "2022-05-30",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"discount_type": "percent",
"discount_value": "0",
"discount_percent": "0",
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_status": "0",
"status_text": "Draft",
"canceled": "0",
"update_date": "2022-06-16 10:15:47",
"products_list": [ ]
}
]
}

Create

Create a document.

Authorizations:

Bearer token

Request Body schema: application/json

id_type	integer Document type Id 1 = Quote 2 = Order note 3 = Delivery note 4 = Invoice
pipeline	integer If added in a new opportunity: Pipeline Id
id_customer required	integer If added in a new opportunity: Customer Id
id_opportunity required	string If adding in an existing opportunity: Opportunity Id
proposal_description	string Proposal description
id_status	integer Status Id Quote 0 = Draft 1 = Pending 2 = Accepted 3 = Refused 4 = Sent Order note 0 = Draft 1 = Pending 2 = Accepted 3 = Refused 4 = Sent Delivery note 0 = Draft 1 = Pending 2 = En préparation 3 = Expédié 4 = Livré Invoice 0 = Draft 1 = Pending 1 = Accepted 2 = Sent 4 = Paid (partially paid is not available)
title	string <= 127 characters Document title
date	string <date-time> Document date
date_end	string <date-time> Expiration date - Not editable for invoices
id_payment_condition	integer Payment condition Id - Only for invoices By defaut, the value of the customer profile, or without, that of the company profile
customer_reference	string Customer reference
description	string Document description
use_stripe_to_pay	integer Stripe use 0 = Inactive 1 = Usable
id_document_template	integer Document template Id By defaut, the value of the customer profile
	Array of Product (object) or Section (object) Articles list

Responses

Request samples

Payload

Content type

application/json

{"id_type": "1",
"pipeline": 1934,
"id_customer": 48560,
"id_opportunity": "1985",
"proposal_description": "A description or note about this proposal",
"id_status": 0,
"title": "Document #1",
"date": "2022-05-16",
"date_end": "2022-05-30",
"id_payment_condition": "1",
"customer_reference": "C1234",
"description": "A description or note about this document",
"use_stripe_to_pay": "0",
"id_document_template": "0",
"products_list": [{"section": "0",
"id_product": "4739",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "125.00",
"quantity": "2.50",
"quantity_delivered": "0",
"id_vat": "1"
},
{"section": "1",
"title": "Section #1",
"description": "A description or note about this section"
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "2758",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_opportunity_proposal": "1835",
"id_type": "1",
"type_text": "Quotes",
"number": "",
"id_status": "0",
"status_text": "Draft",
"title": "Document #1",
"date": "2022-05-16",
"date_end": "2022-05-30",
"id_payment_condition": "1",
"id_document_reference": "0",
"customer_reference": "C1234",
"id_customer_supplier_contact": "48560",
"description": "A description or note about this document",
"discount_type": "percent",
"discount_value": 0,
"final_invoice": "0",
"deposit_type": "percent",
"deposit_value": 0,
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"id_currency": "43",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16 00:00:00",
"use_stripe_to_pay": "0",
"canceled": "0",
"id_document_template": "0",
"download_url": "",
"products_list": [{"section": "0",
"id_product": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"id_vat": "1",
"vat": "20.00",
"vat_text": "TVA 20%",
"quantity": "2.50",
"quantity_delivered": "0",
"id_unit": "2",
"unit": "unité",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "125.00",
"total_cost": "150.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
},
{"section": "1",
"id_product": "0",
"title": "Section #1",
"reference": "",
"description": "A description or note about this section",
"price_without_tax": "0.000000",
"id_vat": "0",
"quantity": "1.00",
"quantity_delivered": "1.00",
"id_unit": "0",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "0.000",
"total_cost": "0.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one document.

Authorizations:

Bearer token

path Parameters

id

required

integer

Document Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "2758",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_opportunity_proposal": "1835",
"id_type": "1",
"type_text": "Quotes",
"number": "",
"id_status": "0",
"status_text": "Draft",
"title": "Document #1",
"date": "2022-05-16 16:15:00",
"date_end": "2022-05-30 14:00:00",
"id_payment_condition": "1",
"id_document_reference": "0",
"customer_reference": "C1234",
"id_customer_supplier_contact": "48560",
"description": "A description or note about this document",
"discount_type": "percent",
"discount_value": 0,
"final_invoice": "0",
"deposit_type": "percent",
"deposit_value": 0,
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"id_currency": "43",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"use_stripe_to_pay": "0",
"canceled": "0",
"id_document_template": "0",
"download_url": "",
"products_list": [{"section": "0",
"id_product": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"id_vat": "1",
"vat": "20.00",
"vat_text": "TVA 20%",
"quantity": "2.50",
"quantity_delivered": "0",
"id_unit": "2",
"unit": "unité",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "125.00",
"total_cost": "150.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
},
{"section": "1",
"id_product": "0",
"title": "Section #1",
"reference": "",
"description": "A description or note about this section",
"price_without_tax": "0.000000",
"id_vat": "0",
"quantity": "1.00",
"quantity_delivered": "1.00",
"id_unit": "0",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "0.000",
"total_cost": "0.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a document.

Authorizations:

Bearer token

path Parameters

id

required

integer

Document Id

Request Body schema: application/json

id_status	integer Status Id Quote 0 = Draft 1 = Pending 2 = Accepted 3 = Refused 4 = Sent Order note 0 = Draft 1 = Pending 2 = Accepted 3 = Refused 4 = Sent Delivery note 0 = Draft 1 = Pending 2 = En préparation 3 = Expédié 4 = Livré Invoice 0 = Draft 1 = Pending 1 = Accepted 2 = Sent 4 = Paid (partially paid is not available)
title	string <= 127 characters Document title
date	string <date-time> Document date
date_end	string <date-time> Expiration date - Not editable for invoices
id_payment_condition	integer Payment condition Id - Only for invoices By defaut, the value of the customer profile, or without, that of the company profile
customer_reference	string Customer reference
description	string Document description
use_stripe_to_pay	integer Stripe use 0 = Inactive 1 = Usable
id_document_template	integer Document template Id By defaut, the value of the customer profile
	Array of Product (object) or Section (object) Articles list

Responses

Request samples

Payload

Content type

application/json

{"id_status": 0,
"title": "Document #1",
"date": "2022-05-16",
"date_end": "2022-05-30",
"id_payment_condition": "1",
"customer_reference": "C1234",
"description": "A description or note about this document",
"use_stripe_to_pay": "0",
"id_document_template": "0",
"products_list": [{"section": "0",
"id_product": "4739",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "125.00",
"quantity": "2.50",
"quantity_delivered": "0",
"id_vat": "1"
},
{"section": "1",
"title": "Section #1",
"description": "A description or note about this section"
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "2758",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_opportunity_proposal": "1835",
"id_type": "1",
"type_text": "Quotes",
"number": "",
"id_status": "0",
"status_text": "Draft",
"title": "Document #1",
"date": "2022-05-16 16:15:00",
"date_end": "2022-05-30 14:00:00",
"id_payment_condition": "1",
"id_document_reference": "0",
"customer_reference": "C1234",
"id_customer_supplier_contact": "48560",
"description": "A description or note about this document",
"discount_type": "percent",
"discount_value": 0,
"final_invoice": "0",
"deposit_type": "percent",
"deposit_value": 0,
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"id_currency": "43",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"use_stripe_to_pay": "0",
"canceled": "0",
"id_document_template": "0",
"download_url": "",
"products_list": [{"section": "0",
"id_product": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"id_vat": "1",
"vat": "20.00",
"vat_text": "TVA 20%",
"quantity": "2.50",
"quantity_delivered": "0",
"id_unit": "2",
"unit": "unité",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "125.00",
"total_cost": "150.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
},
{"section": "1",
"id_product": "0",
"title": "Section #1",
"reference": "",
"description": "A description or note about this section",
"price_without_tax": "0.000000",
"id_vat": "0",
"quantity": "1.00",
"quantity_delivered": "1.00",
"id_unit": "0",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "0.000",
"total_cost": "0.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update status

Update the status of the document.

Authorizations:

Bearer token

path Parameters

id

required

integer

Document Id

Request Body schema: application/json

id_status

integer

Status Id

Quote
0 = Draft
1 = Pending
2 = Accepted
3 = Refused
4 = Sent

Order note
0 = Draft
1 = Pending
2 = Accepted
3 = Refused
4 = Sent

Delivery note
0 = Draft
1 = Pending
2 = En préparation
3 = Expédié
4 = Livré

Invoice
0 = Draft
1 = Pending
1 = Accepted
2 = Sent
4 = Paid (partially paid is not available)

Responses

Request samples

Payload

Content type

application/json

{"id_status": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "2758",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_opportunity_proposal": "1835",
"id_type": "1",
"type_text": "Quotes",
"number": "",
"id_status": "0",
"status_text": "Draft",
"title": "Document #1",
"date": "2022-05-16 16:15:00",
"date_end": "2022-05-30 14:00:00",
"id_payment_condition": "1",
"id_document_reference": "0",
"customer_reference": "C1234",
"id_customer_supplier_contact": "48560",
"description": "A description or note about this document",
"discount_type": "percent",
"discount_value": 0,
"final_invoice": "0",
"deposit_type": "percent",
"deposit_value": 0,
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"id_currency": "43",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"use_stripe_to_pay": "0",
"canceled": "0",
"id_document_template": "0",
"download_url": "",
"products_list": [{"section": "0",
"id_product": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"id_vat": "1",
"vat": "20.00",
"vat_text": "TVA 20%",
"quantity": "2.50",
"quantity_delivered": "0",
"id_unit": "2",
"unit": "unité",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "125.00",
"total_cost": "150.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
},
{"section": "1",
"id_product": "0",
"title": "Section #1",
"reference": "",
"description": "A description or note about this section",
"price_without_tax": "0.000000",
"id_vat": "0",
"quantity": "1.00",
"quantity_delivered": "1.00",
"id_unit": "0",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "0.000",
"total_cost": "0.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Templates

Get a list of all documents templates.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "36",
"title": "Template #1"
}
]
}

Products

This section lists all product-related APIS.

List

Get a list of all products.

Authorizations:

Bearer token

query Parameters

fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": "0",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"business_price_per_quantity": "0",
"expense_price_per_quantity": "0",
"id_vat": "1",
"id_unit": "17",
"use_stock": "1",
"stock": "50.00",
"stock_min_alert": "10.00",
"stock_max_alert": "100.00",
"weighted_average_cost": "0.00",
"cost_without_tax": "0.00",
"id_supplier": "28549",
"reference_supplier": "Ref_supllier_1",
"compound_product": "0",
"compound_product_links": [{"id_product": "3430",
"quantity": "3",
"display_on_document": "1",
"title": "Product #2",
"id_unit": "3",
"use_stock": "1",
"stock": "58"
}
],
"linked_to_compound_product": "0",
"sold_only_in_compound_product": "0",
"custom_fields_list": [{"id": "3430",
"title": "Conditioning",
"value": "6019",
"value_text": "Box"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a product.

Authorizations:

Bearer token

Request Body schema: application/json

title required	string <= 127 characters Product title
reference	string <= 30 characters Product reference
id_product_category	integer Product category Id
description	string Product decription
price_without_tax	number <float> Sell price HT
id_vat	integer Vat Id
id_unit	integer Unit Id
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": 0,
"description": "A description or note about this product",
"price_without_tax": 50,
"id_vat": 0,
"id_unit": 0,
"custom_fields": [{"id": 3430,
"value": 6019
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": "0",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"business_price_per_quantity": "0",
"expense_price_per_quantity": "0",
"id_vat": "1",
"id_unit": "17",
"use_stock": "1",
"stock": "50.00",
"stock_min_alert": "10.00",
"stock_max_alert": "100.00",
"weighted_average_cost": "0.00",
"cost_without_tax": "0.00",
"id_supplier": "28549",
"reference_supplier": "Ref_supllier_1",
"compound_product": "0",
"compound_product_links": [{"id_product": "3430",
"quantity": "3",
"display_on_document": "1",
"title": "Product #2",
"id_unit": "3",
"use_stock": "1",
"stock": "58"
}
],
"linked_to_compound_product": "0",
"sold_only_in_compound_product": "0",
"custom_fields_list": [{"id": "3430",
"title": "Conditioning",
"value": "6019",
"value_text": "Box"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one product.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"id": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": "0",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"business_price_per_quantity": "0",
"expense_price_per_quantity": "0",
"id_vat": "1",
"id_unit": "17",
"use_stock": "1",
"stock": "50.00",
"stock_min_alert": "10.00",
"stock_max_alert": "100.00",
"weighted_average_cost": "0.00",
"cost_without_tax": "0.00",
"id_supplier": "28549",
"reference_supplier": "Ref_supllier_1",
"compound_product": "0",
"compound_product_links": [{"id_product": "3430",
"quantity": "3",
"display_on_document": "1",
"title": "Product #2",
"id_unit": "3",
"use_stock": "1",
"stock": "58"
}
],
"linked_to_compound_product": "0",
"sold_only_in_compound_product": "0",
"custom_fields_list": [{"id": "3430",
"title": "Conditioning",
"value": "6019",
"value_text": "Box"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a product.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

title	string <= 127 characters Product title
reference	string <= 30 characters Product reference
id_product_category	integer Product category Id
description	string Product decription
price_without_tax	number <float> Sell price HT
id_vat	integer Vat Id
id_unit	integer Unit Id
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": 0,
"description": "A description or note about this product",
"price_without_tax": 50,
"id_vat": 0,
"id_unit": 0,
"custom_fields": [{"id": 3430,
"value": 6019
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": "0",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"business_price_per_quantity": "0",
"expense_price_per_quantity": "0",
"id_vat": "1",
"id_unit": "17",
"use_stock": "1",
"stock": "50.00",
"stock_min_alert": "10.00",
"stock_max_alert": "100.00",
"weighted_average_cost": "0.00",
"cost_without_tax": "0.00",
"id_supplier": "28549",
"reference_supplier": "Ref_supllier_1",
"compound_product": "0",
"compound_product_links": [{"id_product": "3430",
"quantity": "3",
"display_on_document": "1",
"title": "Product #2",
"id_unit": "3",
"use_stock": "1",
"stock": "58"
}
],
"linked_to_compound_product": "0",
"sold_only_in_compound_product": "0",
"custom_fields_list": [{"id": "3430",
"title": "Conditioning",
"value": "6019",
"value_text": "Box"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a product.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
401

Content type

application/json

null

Custom fields

Get a list of all products custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "3346",
"title": "Conditioning",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of products custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Product custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "6019",
"title": "Box "
},
{"id"": "6021",
"title": "Cardboard"
},
{"id": "6020",
"title": "Pallet"
}
]
}

Add/Update custom field

Add or update a product custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Product Id
field_id required	integer Products custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 6019
}

Response samples

200
400
401

Content type

application/json

{"id": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"id_product_category": "0",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"business_price_per_quantity": "0",
"expense_price_per_quantity": "0",
"id_vat": "1",
"id_unit": "17",
"use_stock": "1",
"stock": "50.00",
"stock_min_alert": "10.00",
"stock_max_alert": "100.00",
"weighted_average_cost": "0.00",
"cost_without_tax": "0.00",
"id_supplier": "28549",
"reference_supplier": "Ref_supllier_1",
"compound_product": "0",
"compound_product_links": [{"id_product": "3430",
"quantity": "3",
"display_on_document": "1",
"title": "Product #2",
"id_unit": "3",
"use_stock": "1",
"stock": "58"
}
],
"linked_to_compound_product": "0",
"sold_only_in_compound_product": "0",
"custom_fields_list": [{"id": "3430",
"title": "Conditioning",
"value": "6019",
"value_text": "Box"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Cost price

Get the unit purchase cost of a product.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

quantity

number <float>

Quantity

Responses

Response samples

200
400
401

Content type

application/json

{"quantity": "1",
"price_without_tax": "20",
"discount_percent": "0"
}

Sell price

Get the unit sell cost of a product.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

quantity	number <float> Quantity
id_products_prices_category	integer Price category Id

Responses

Response samples

200
400
401

Content type

application/json

{"quantity": "1",
"price_without_tax": "50.000000",
"discount_percent": "0"
}

Stock follow

Get the stock follow of a product.

Authorizations:

Bearer token

path Parameters

id

required

integer

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"date": "2022-08-15",
"document_number": "F22-155",
"quantity": "6",
"update_date": "2022-08-15 12:04:24"
}
]
}

List sells prices categories

Get a list of all sells prices categories of products.

Authorizations:

Bearer token

query Parameters

fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 2,
"limit": 100,
"offset": 0
},
"data": [{"id": "16",
"title": "Individuals",
"creation_date": "2022-04-13 09:45:42",
"created_by": "213",
"update_date": "2022-04-13 09:45:51",
"updated_by": "213"
},
{"id": "17",
"title": "Professionals",
"creation_date": "2022-04-13 09:46:08",
"created_by": "213",
"update_date": "2022-04-13 09:46:14",
"updated_by": "213"
}
]
}

List categories

Get a list of all categories.

Authorizations:

Bearer token

query Parameters

fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "510",
"title": "Category #1",
"creation_date": "2022-04-13 12:09:06",
"created_by": "213",
"update_date": "2022-04-13 12:09:13",
"updated_by": "213"
}
]
}

Create category

Create a product category

Authorizations:

Bearer token

Request Body schema: application/json

title

required

string <= 127 characters

Product category title

Responses

Request samples

Payload

Content type

application/json

{"title": "Category #1"
}

Response samples

200
400
401

Content type

application/json

{"id": "510",
"title": "Category #1",
"creation_date": "2022-04-13 12:09:06",
"created_by": "213",
"update_date": "2022-04-13 12:09:13",
"updated_by": "213"
}

Show category

Get one product category.

Authorizations:

Bearer token

path Parameters

category_id

required

integer

Category Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "510",
"title": "Category #1",
"creation_date": "2022-04-13 12:09:06",
"created_by": "213",
"update_date": "2022-04-13 12:09:13",
"updated_by": "213"
}

Update category

Update a product category.

Authorizations:

Bearer token

path Parameters

category_id

required

integer

Category Id

Request Body schema: application/json

title

string <= 127 characters

Product category title

Responses

Request samples

Payload

Content type

application/json

{"title": "Category #1"
}

Response samples

200
400
401

Content type

application/json

{"id": "510",
"title": "Category #1",
"creation_date": "2022-04-13 12:09:06",
"created_by": "213",
"update_date": "2022-04-13 12:09:13",
"updated_by": "213"
}

List inventories

Get inventories list.

Authorizations:

Bearer token

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_product	integer Search by product Id
id	integer Search by Inventory Id
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "15",
"date": "2022-08-15",
"title": "Inventory 15/08/2022",
"list_products": [{"id_product": "3430",
"title": "Product #2",
"old_stock": "5",
"new_stock": "40",
"difference": "35"
}
]
}
]
}

VAT

Get a list of all 'Value Added Tax'.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "6019",
"title": "Box "
},
{"id"": "6021",
"title": "Cardboard"
},
{"id": "6020",
"title": "Pallet"
}
]
}

Units

Get a list of all units.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"vat": "20.00",
"title": "VAT 20%"
},
{"id": "2",
"vat": "10.00",
"title": "VAT 10%"
},
{"id": "3",
"vat": "5.50",
"title": "VAT 5.5%"
}
]
}

Equipments

This section lists all product-related APIS.

List

Get a list of all equipments.

Authorizations:

Bearer token

query Parameters

title	string <= 127 characters Search by title
reference	string <= 30 characters Search by reference
serial_number	string <= 127 characters Search by serial number
id_customer_supplier	integer Search by customer Id
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "1",
"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": "28496",
"custom_fields_list": [{"id": "3671",
"title": "tag",
"value": "6338",
"value_text": "tag1"
}
],
"creation_date": "2022-07-20 12:38:28",
"created_by": "213",
"update_date": "2022-07-20 12:38:28",
"updated_by": "213"
}
]
}

Create

Create an equipment.

Authorizations:

Bearer token

Request Body schema: application/json

title required	string <= 127 characters Equipment title
reference	string <= 30 characters Equipment reference
description	string Equipment description
serial_number	integer <= 127 characters Equipment serial number
id_customer_supplier	integer Customer Id
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": 28496,
"custom_fields": [{"id": 3671,
"value": 6338
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "1",
"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": "28496",
"custom_fields_list": [{"id": "3671",
"title": "tag",
"value": "6338",
"value_text": "tag1"
}
],
"creation_date": "2022-07-20 12:38:28",
"created_by": "213",
"update_date": "2022-07-20 12:38:28",
"updated_by": "213"
}

Show

Get one equipment.

Authorizations:

Bearer token

path Parameters

id

required

integer

Equipment Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "1",
"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": "28496",
"custom_fields_list": [{"id": "3671",
"title": "tag",
"value": "6338",
"value_text": "tag1"
}
],
"creation_date": "2022-07-20 12:38:28",
"created_by": "213",
"update_date": "2022-07-20 12:38:28",
"updated_by": "213"
}

Update

Update an equipment.

Authorizations:

Bearer token

path Parameters

id

required

integer

Equipment Id

Request Body schema: application/json

title	string <= 127 characters Equipment title
reference	string <= 30 characters Equipment reference
description	string Equipment description
serial_number	integer <= 127 characters Equipment serial number
id_customer_supplier	integer Customer Id
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": 28496,
"custom_fields": [{"id": 3671,
"value": 6338
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "1",
"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": "28496",
"custom_fields_list": [{"id": "3671",
"title": "tag",
"value": "6338",
"value_text": "tag1"
}
],
"creation_date": "2022-07-20 12:38:28",
"created_by": "213",
"update_date": "2022-07-20 12:38:28",
"updated_by": "213"
}

Delete

Delete an equipment.

Authorizations:

Bearer token

path Parameters

id

required

integer

Equipment Id

Responses

Response samples

200
401

Content type

application/json

null

Custom fields

Get a list of all equipments custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "3671",
"title": "tag",
"type": "Tags",
"with_values": "true"
}
]
}

Custom field values

Get values of equipments custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Equipment custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3671",
"title": "tag "
},
{"id"": "6338",
"title": "tag1"
}
]
}

Add/Update custom field

Add or update an equipment custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Equipment Id
field_id required	integer Equipment custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 6338
}

Response samples

200
400
401

Content type

application/json

{"id": "1",
"title": "Equipment #1",
"reference": "Ref_equipment_1",
"description": "A description or note about this equipment",
"serial_number": "SN1234",
"id_customer_supplier": "28496",
"custom_fields_list": [{"id": "3671",
"title": "tag",
"value": "6338",
"value_text": "tag1"
}
],
"creation_date": "2022-07-20 12:38:28",
"created_by": "213",
"update_date": "2022-07-20 12:38:28",
"updated_by": "213"
}

Purchases

This section lists all purchases-related APIS.

List

Get a list of all purchases.

Authorizations:

Bearer token

query Parameters

from	string <date-time> Search by purchase date
to	string <date-time> Search by due date
id_supplier	integer Search by supplier Id
status_not_draft	integer List all the purchases not in draft status No expected value, do not use this field if you don't want to list purchases not in draft status
include_deleted	integer Include all deleted purchases (only last 30 days deleted purchases are available) No expected value, do not use this field if you don't want to list purchases deleted
creation_date_min	string <date-time> Search by creation date
creation_date_max	string <date-time> Search by creation date
update_date_min	string <date-time> Search by update date
update_date_max	string <date-time> Search by update date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"pagination": {"total": 3,
"limit": 100,
"offset": 0
},
"data": [{"id": "961",
"id_supplier": "48560",
"supplier_title": "Society X",
"title": "Purchase #1",
"id_status": "0",
"status_text": "Draft",
"date": "2022-04-01",
"date_end": "2022-05-01",
"id_chart_of_account_expenses": "596",
"total_without_tax": "40.00",
"total_with_tax": "48.00",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"update_date": "2022-06-16 10:15:47",
"active": "1",
"allocate_list": [ ]
}
]
}

Create

Create a purchase.

Authorizations:

Bearer token

Request Body schema: application/json

id_supplier	integer Supplier Id
id_status	integer Purchase status Id 0 = Draft 1 = Pending 3 = Paid
title	string <= 127 characters Reference of the purchase
date	string <date-time> Purchase date
date_end	string <date-time> Due date
description	string <= 255 characters Purchase description
id_chart_of_account_expenses	string <= 30 characters Chart of accounts Id
total_without_tax	number Total HT
id_vat	integer Vat number Id
upload_file_content	string Content of the file to upload (base64)
upload_file_url	string URL of the file to upload Do not use URL with protected file which need to be connected to access to the file Used only if upload_file_content is empty or not defined
upload_file_name	string Name of the file

Responses

Request samples

Payload

Content type

application/json

{"id_supplier": 48560,
"id_status": 0,
"title": "Purchase #1",
"date": "2022-04-01",
"date_end": "2022-05-01",
"description": "A description or note about this purchase",
"id_chart_of_account_expenses": 596,
"total_without_tax": 40,
"id_vat": 0,
"upload_file_content": "",
"upload_file_url": "",
"upload_file_name": ""
}

Response samples

200
400
401

Content type

application/json

{"id": "961",
"id_supplier": "48560",
"id_status": "0",
"status_text": "Draft",
"title": "Purchase #1",
"date": "2022-04-01",
"date_end": "2022-05-01",
"description": "A description or note about this purchase",
"id_chart_of_account_expenses": ["596"
],
"total_without_tax": "40.00",
"total_with_tax": "48.00",
"id_vat": "2",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-05-01",
"download_url": "",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one purchase.

Authorizations:

Bearer token

path Parameters

id

required

integer

Purchase Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "961",
"id_supplier": "48560",
"id_status": "0",
"status_text": "Draft",
"title": "Purchase #1",
"date": "2022-04-01",
"date_end": "2022-05-01",
"description": "A description or note about this purchase",
"id_chart_of_account_expenses": ["596"
],
"total_without_tax": "40.00",
"total_with_tax": "48.00",
"id_vat": "2",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-05-01",
"download_url": "",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a purchase.

Authorizations:

Bearer token

path Parameters

id

required

integer

Expense Id

Request Body schema: application/json

id_supplier	integer Supplier Id
id_status	integer Purchase status 0 = Draft 1 = Pending 3 = Paid
title	string <= 127 characters Reference of the purchase
date	string <date-time> Purchase date
date_end	string <date-time> Due date
description	string <= 255 characters Purchase description
id_chart_of_account_expenses	string <= 30 characters Chart of accounts Id
total_without_tax	number Total HT
id_vat	integer Vat number Id
upload_file_content	string Content of the file to upload (base64) If file has already been uploaded, it won't be replaced
upload_file_url	string URL of the file to upload Do not use URL with protected file which need to be connected to access to the file Used only if upload_file_content is empty or not defined If file has already been uploaded, it won't be replaced
upload_file_name	string Name of the file

Responses

Request samples

Payload

Content type

application/json

{"id_supplier": 48560,
"id_status": 0,
"title": "Purchase #1",
"date": "2022-04-01",
"date_end": "2022-05-01",
"description": "A description or note about this purchase",
"id_chart_of_account_expenses": 596,
"total_without_tax": 40,
"id_vat": 0,
"upload_file_content": "",
"upload_file_url": "",
"upload_file_name": ""
}

Response samples

200
400
401

Content type

application/json

{"id": "961",
"id_supplier": "48560",
"id_status": "0",
"status_text": "Draft",
"title": "Purchase #1",
"date": "2022-04-01",
"date_end": "2022-05-01",
"description": "A description or note about this purchase",
"id_chart_of_account_expenses": ["596"
],
"total_without_tax": "40.00",
"total_with_tax": "48.00",
"id_vat": "2",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-05-01",
"download_url": "",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Chart of accounts

Get a list of all chart of accounts.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "596",
"code": "607",
"title": "Purchases of goods",
"description": "Purchases of raw materials that are to be processed for resale.",
"id_family": "1",
"family_title": "Purchases and subcontracting"
},
{"id": "597",
"code": "601",
"title": "Purchases of raw materials",
"description": "Purchases of goods for resale in the same condition as received",
"id_family": "1",
"family_title": "Purchases and subcontracting"
}
]
}

Families of chart of accounts

Get a list of all families of chart of accounts .

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "Purchasing and subcontracting"
},
{"id": "2",
"title": "Running costs"
},
{"id": "3",
"title": "Communication and marketing"
}
]
}

Suppliers Documents

This section lists all suppliers documents-related APIS.

List

Get a list of all suppliers documents.

Authorizations:

Bearer token

query Parameters

type	integer Document type 2 => Orders 3 => Deliveries 4 => Invoices
id_supplier	integer Search by supplier Id
id_user_assigned	string Users with group Id associated with the oportunity
document_number	string <= 30 characters Document number
status_not_draft	integer List all the documents not in draft status No expected value, do not use this field if you don't want to list documents not in draft status
include_deleted	integer Include all deleted documents (only last 30 days deleted purchases are available) No expected value, do not use this field if you don't want to list documents deleted
creation_date_min	string <date-time> Search by creation date
creation_date_max	string <date-time> Search by creation date
update_date_min	string <date-time> Search by update date
update_date_max	string <date-time> Search by update date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "85",
"id_customer_supplier": "48560",
"customer_supplier_title": "Society X",
"id_opportunity": "1985",
"id_type": "2",
"type_text": "Orders",
"number": "",
"date": "2022-05-16",
"date_end": "2022-05-30",
"id_user_assigned": ["u213"
],
"id_user_assigned_text": ["Jean Dupont"
],
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_status": "0",
"status_text": "Draft",
"update_date": "2022-06-16 10:15:47",
"active": "1"
}
]
}

Show

Get one supplier document.

Authorizations:

Bearer token

path Parameters

id

required

integer

Supplier document Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "85",
"id_document_previous": "2757",
"id_document_next": "2759",
"id_customer_supplier": "48560",
"id_opportunity": "1985",
"id_opportunity_proposal": "1835",
"id_type": "2",
"type_text": "Order",
"number": "",
"id_status": "0",
"status_text": "Draft",
"title": "Document #1",
"date": "2022-05-16 16:15:00",
"date_end": "2022-05-30 14:00:00",
"id_payment_condition": "1",
"id_document_reference": "0",
"customer_reference": "",
"id_customer_supplier_contact": "48560",
"description": "A description or note about this document",
"discount_type": "percent",
"discount_value": 0,
"total_without_tax": "125.00",
"total_with_tax": "150.00",
"id_currency": "43",
"currency_code": "EUR",
"currency_exchange_rate": "1.000000",
"total_already_paid": "0.00",
"payment_date": "2022-06-16",
"id_document_template": "0",
"products_list": [{"section": "0",
"id_product": "4739",
"title": "Product #1",
"reference": "Ref_product_1",
"description": "A description or note about this product",
"price_without_tax": "50.000000",
"id_vat": "1",
"quantity": "2.50",
"quantity_delivered": "0",
"id_unit": "2",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "125.00",
"total_cost": "150.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
},
{"section": "1",
"id_product": "0",
"title": "Section #1",
"reference": "",
"description": "A description or note about this section",
"price_without_tax": "0.000000",
"id_vat": "0",
"quantity": "1.00",
"quantity_delivered": "1.00",
"id_unit": "0",
"discount_type": "percent",
"discount_value": 0,
"progress_type": "percent",
"progress_value": 0,
"total_without_tax": "0.000",
"total_cost": "0.00",
"hide_in_pdf": "0",
"optional": "0",
"creation_date": "2022-04-19 14:45:28",
"created_by": "213",
"update_date": "2022-04-19 14:45:28",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Events

This section lists all event-related APIS.

List

Get a list of all events.

Authorizations:

Bearer token

query Parameters

id_user_assigned required	integer User Id associated with the event
from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_customer_supplier	integer Search by customer Id or supplier Id
id_opportunity	integer Search by opportunity Id
id_event_type	integer Search by event type Id
id_project	integer Search by project Id
id_project_task	integer Search by project task Id
title	string <= 127 characters Search by title
private	integer Search by private status 0 = No 1 = Yes
visible_in_agenda	integer Search by visibility 0 = No 1 = Yes
synchronized	integer Search by synchronization 0 = No 1 = Yes
use_time	integer Search by event used for time 0 = No 1 = Yes
time_id_type	integer Search by time type Id
time_billable	integer Search by time billable 0 = No 1 = Billable 2 = Billed
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create an event.

Authorizations:

Bearer token

Request Body schema: application/json

id_user_assigned required	string User Id associated with the event Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_event_type	integer Event type Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
start_date	string <date-time> Start date
end_date	string <date-time> End date
title	string <= 255 characters Event title
description	string Event descritpion
private	integer Event private status 0 = No 1 = Yes
visible_in_agenda	integer Visibility in the agenda 0 = No 1 = Yes
use_time	integer Event used for time 0 = No 1 = Yes
time_id_type	integer Time type Id
time_billable	integer Billable time 0 = No 1 = Billable

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_event_type": 3021,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": 0,
"visible_in_agenda": 1,
"use_time": 1,
"time_id_type": 0,
"time_billable": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one event.

Authorizations:

Bearer token

path Parameters

id

required

integer

Event Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update an event.

Authorizations:

Bearer token

path Parameters

id

required

integer

Event Id

Request Body schema: application/json

id_user_assigned	string User Id associated with the event Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_event_type	integer Event type Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
start_date	string <date-time> Start date
end_date	string <date-time> End date
title	string <= 255 characters Event title
description	string Event descritpion
private	integer Event private status 0 = No 1 = Yes
visible_in_agenda	integer Visibility in the agenda 0 = No 1 = Yes
use_time	integer Event used for time 0 = No 1 = Yes
time_id_type	integer Time type Id
time_billable	integer Billable time 0 = No 1 = Billable

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_event_type": 3021,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": 0,
"visible_in_agenda": 1,
"use_time": 1,
"time_id_type": 0,
"time_billable": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Event #1",
"description": "A description or note about this event",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete an event.

Authorizations:

Bearer token

path Parameters

id

required

integer

Event Id

Responses

Response samples

200
400
401

Content type

application/json

null

Types

Get a list of all events types.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3019",
"title": "Appel téléphonique",
"title_en": "Phone call",
"title_es": "Llamada telefónica"
},
{"id": "3020",
"title": "Echange de mail",
"title_en": "Mail exchange",
"title_es": "Intercambio de correo electrónico"
},
{"id": "3021",
"title": "Rendez-vous",
"title_en": "Appointment",
"title_es": "Cita"
},
{"id": "3022",
"title": "Echange de courrier",
"title_en": "Letter exchange",
"title_es": "Intercambio de correo"
}
]
}

Notes

This section lists all note-related APIS.

List

Get a list of all notes.

Authorizations:

Bearer token

query Parameters

id_user_assigned required	integer User Id associated with the note
from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_customer_supplier	integer Search by customer Id or supplier Id
id_opportunity	integer Search by opportunity Id
id_project	integer Search by project Id
id_project_task	integer Search by project task Id
title	string <= 127 characters Search by title
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "10730",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"date": "2022-04-06 16:15:00",
"title": "Note #1",
"description": "A description or note about this note",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a note.

Authorizations:

Bearer token

Request Body schema: application/json

id_user_assigned required	string User Id associated with the note Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
date	string <date-time> Start date
title	string <= 255 characters Note title
description	string Note descritpion

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"date": "2022-03-15 19:45:00",
"title": "Event #1",
"description": "A description or note about this note"
}

Response samples

200
400
401

Content type

application/json

{"id": "10730",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"date": "2022-04-06 16:15:00",
"title": "Note #1",
"description": "A description or note about this note",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one note.

Authorizations:

Bearer token

path Parameters

id

required

integer

Note Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "10730",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"date": "2022-04-06 16:15:00",
"title": "Note #1",
"description": "A description or note about this note",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a note.

Authorizations:

Bearer token

path Parameters

id

required

integer

Note Id

Request Body schema: application/json

id_user_assigned	string User Id associated with the note Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
date	string <date-time> Start date
title	string <= 255 characters Note title
description	string Note descritpion

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"date": "2022-03-15 19:45:00",
"title": "Event #1",
"description": "A description or note about this note"
}

Response samples

200
400
401

Content type

application/json

{"id": "10730",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"date": "2022-04-06 16:15:00",
"title": "Note #1",
"description": "A description or note about this note",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a note.

Authorizations:

Bearer token

path Parameters

id

required

integer

Note Id

Responses

Response samples

200
400
401

Content type

application/json

null

Tasks

This section lists all task-related APIS.

List

Get a list of all tasks.

Authorizations:

Bearer token

query Parameters

id_user_assigned required	integer User Id associated with the task
status	integer Search by task status 0 = Open 1 = Close
from	string <date-time> Search by start date
to	string <date-time> Search by end date
id_customer_supplier	integer Search by customer Id or supplier Id
id_opportunity	integer Search by opportunity Id
id_event_type	integer Search by task type Id
id_project	integer Search by project Id
id_project_task	integer Search by project task Id
title	string <= 127 characters Search by title
private	integer Search by private status 0 = No 1 = Yes
visible_in_agenda	integer Search by visibility 0 = No 1 = Yes
synchronized	integer Search by synchronization 0 = No 1 = Yes
use_time	integer Search by task used for time 0 = No 1 = Yes
time_id_type	integer Search by time type Id
time_billable	integer Search by time billable 0 = No 1 = Billable 2 = Billed
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a task.

Authorizations:

Bearer token

Request Body schema: application/json

id_user_assigned required	string User Id associated with the task Email address can be used here
status	integer Task status 0 = Open 1 = Close
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_event_type	integer Task type Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
start_date	string <date-time> Start date
end_date	string <date-time> End date
title	string <= 255 characters Task title
description	string Task descritpion
private	integer Task private status 0 = No 1 = Yes
visible_in_agenda	integer Visibility in the agenda 0 = No 1 = Yes
use_time	integer Task used for time 0 = No 1 = Yes
time_id_type	integer Time type Id Id
time_billable	integer Billable time 0 = No 1 = Billable

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"status": 0,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_event_type": 3021,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": 0,
"visible_in_agenda": 1,
"use_time": 1,
"time_id_type": 0,
"time_billable": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one task.

Authorizations:

Bearer token

path Parameters

id

required

integer

Task Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a task.

Authorizations:

Bearer token

path Parameters

id

required

integer

Task Id

Request Body schema: application/json

id_user_assigned	string User Id associated with the task Email address can be used here
status	integer Task status 0 = Open 1 = Close
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_event_type	integer Task type Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_ticketing_ticket	integer Ticket Id
start_date	string <date-time> Start date
end_date	string <date-time> End date
title	string <= 255 characters Task title
description	string Task descritpion
private	integer Task private status 0 = No 1 = Yes
visible_in_agenda	integer Visibility in the agenda 0 = No 1 = Yes
use_time	integer Task used for time 0 = No 1 = Yes
time_id_type	integer Time type Id Id
time_billable	integer Billable time 0 = No 1 = Billable

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"status": 0,
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_event_type": 3021,
"id_project": "",
"id_project_task": "",
"id_ticketing_ticket": "",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": 0,
"visible_in_agenda": 1,
"use_time": 1,
"time_id_type": 0,
"time_billable": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_event_type": "3021",
"id_project": "0",
"id_project_task": "0",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"start_date": "2022-03-15 19:45:00",
"end_date": "2022-03-15 20:45:00",
"title": "Task #1",
"description": "A description or note about this task",
"private": "0",
"visible_in_agenda": "1",
"synchronized": "0",
"use_time": "1",
"time_duration": "01:00:00",
"time_id_type": "0",
"time_billable": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a task.

Authorizations:

Bearer token

path Parameters

id

required

integer

Task Id

Responses

Response samples

200
400
401

Content type

application/json

null

Types

Get a list of all tasks types.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "3019",
"title": "Appel téléphonique",
"title_en": "Phone call",
"title_es": "Llamada telefónica"
},
{"id": "3020",
"title": "Echange de mail",
"title_en": "Mail exchange",
"title_es": "Intercambio de correo electrónico"
},
{"id": "3021",
"title": "Rendez-vous",
"title_en": "Appointment",
"title_es": "Cita"
},
{"id": "3022",
"title": "Echange de courrier",
"title_en": "Letter exchange",
"title_es": "Intercambio de correo"
}
]
}

Calls

This section lists all call-related APIS.

List

Get a list of all calls.

Authorizations:

Bearer token

query Parameters

from	string <date-time> Search by start date
to	string <date-time> Search by end date
call_system	integer Call system 0 = Karlia 1 = Ringover 2 = Aircall 3 = Wildix
id_user_assigned	integer User Id associated with the call
id_customer_supplier	integer Search by customer Id or supplier Id
id_opportunity	integer Search by opportunity Id
id_call_type	integer Search by call type Id
id_call_follow	integer Search by call follow Id
number	string Search by phone number
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "10722",
"call_system": "0",
"call_system_text": "Karlia",
"id_customer_supplier": "0",
"id_customer_supplier_contact": "0",
"id_opportunity": "0",
"start_date": "2022-03-15 19:45:00",
"duration_seconds": "120",
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": "1",
"call_type_text": "Appel entrant",
"id_user_assigned": "0",
"id_call_follow": "2",
"call_follow_text": "Sans intérêt",
"description": "A description or note about this call",
"creation_date": "2022-03-25 12:04:24",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a call.

Authorizations:

Bearer token

Request Body schema: application/json

call_system_text	string Call system (text) Karlia (by default) Ringover Aircall Wildix
id_user_assigned	string User Id associated with the call Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_customer_supplier_contact	integer Contact Id
id_opportunity	integer Opportunity Id
start_date	string <date-time> Start date
duration_seconds	integer Call duration in seconds
from_number	string From number phone
to_number	string To number phone
id_call_type	integer Call type Id
id_call_follow	integer Call follow Id
description	string Call descritpion

Responses

Request samples

Payload

Content type

application/json

{"call_system_text": "Karlia",
"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_customer_supplier_contact": 0,
"id_opportunity": 1985,
"start_date": "2022-03-15 19:45:00",
"duration_seconds": 120,
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": 3,
"id_call_follow": 0,
"description": "A description or note about this call"
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"call_system": "0",
"call_system_text": "Karlia",
"id_customer_supplier": "0",
"id_customer_supplier_contact": "0",
"id_opportunity": "0",
"start_date": "2022-03-15 19:45:00",
"duration_seconds": "120",
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": "1",
"call_type_text": "Appel entrant",
"id_user_assigned": "0",
"id_call_follow": "2",
"call_follow_text": "Sans intérêt",
"description": "A description or note about this call",
"creation_date": "2022-03-25 12:04:24",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one call.

Authorizations:

Bearer token

path Parameters

id

required

integer

Call Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"call_system": "0",
"call_system_text": "Karlia",
"id_customer_supplier": "0",
"id_customer_supplier_contact": "0",
"id_opportunity": "0",
"start_date": "2022-03-15 19:45:00",
"duration_seconds": "120",
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": "1",
"call_type_text": "Appel entrant",
"id_user_assigned": "0",
"id_call_follow": "2",
"call_follow_text": "Sans intérêt",
"description": "A description or note about this call",
"creation_date": "2022-03-25 12:04:24",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a call.

Authorizations:

Bearer token

path Parameters

id

required

integer

Call Id

Request Body schema: application/json

id_user_assigned	string User Id associated with the call Email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_customer_supplier_contact	integer Contact Id
id_opportunity	integer Opportunity Id
start_date	string <date-time> Start date
duration_seconds	integer Call duration in seconds
from_number	string From number phone
to_number	string To number phone
id_call_type	integer Call type Id
id_call_follow	integer Call follow Id
description	string Call descritpion

Responses

Request samples

Payload

Content type

application/json

{"id_user_assigned": 213,
"id_customer_supplier": 28496,
"id_customer_supplier_contact": 0,
"id_opportunity": 1985,
"start_date": "2022-03-15 19:45:00",
"duration_seconds": 120,
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": 3,
"id_call_follow": 0,
"description": "A description or note about this call"
}

Response samples

200
400
401

Content type

application/json

{"id": "10722",
"call_system": "0",
"call_system_text": "Karlia",
"id_customer_supplier": "0",
"id_customer_supplier_contact": "0",
"id_opportunity": "0",
"start_date": "2022-03-15 19:45:00",
"duration_seconds": "120",
"from_number": "+33 1 23 45 67 89",
"to_number": "+33 9 87 65 43 21",
"id_call_type": "1",
"call_type_text": "Appel entrant",
"id_user_assigned": "0",
"id_call_follow": "2",
"call_follow_text": "Sans intérêt",
"description": "A description or note about this call",
"creation_date": "2022-03-25 12:04:24",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a call.

Authorizations:

Bearer token

path Parameters

id

required

integer

Call Id

Responses

Response samples

200
400
401

Content type

application/json

null

Object for number

Get object (customer, supplier, contact) for a phone number.

Authorizations:

Bearer token

query Parameters

number

string

Search by phone number

Responses

Response samples

200
400
401

Content type

application/json

{"type": "contact",
"url": "https://karlia.fr/...",
"id_customer_supplier": "50",
"id_customer_supplier_contact": "28",
"supplier": "0",
"customer_supplier_title": "Karlia",
"firstname": "Jean",
"lastname": "DUPONT",
"phone": "+33 1 23 45 67 89",
"mobile": "+33 6 87 65 43 21",
"email": "contact@example.com"
}

Types

Get a list of all calls types.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "Appel entrant"
},
{"id": "2",
"title": "Appel sortant"
},
{"id": "3",
"title": "Appel manqué"
},
{"id": "4",
"title": "Message téléphonique"
},
{"id": "5",
"title": "SMS reçu"
},
{"id": "6",
"title": "SMS envoyé"
}
]
}

Follows

Get a list of all calls follows.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "Appel réussi",
"title_en": "Successful call",
"title_es": "llamada exitosa"
},
{"id": "2",
"title": "Sans intérêt",
"title_en": "No interest",
"title_es": "Sin interés"
}
]
}

Times

This section lists all time-related APIS.

List

Get a list of all times.

Authorizations:

Bearer token

query Parameters

id_user	integer User Id
id_project	integer Search by project Id
id_project_task	integer Search by project task Id
id_customer_supplier	integer Search by customer Id or supplier Id
id_type	integer Search by time type Id
billable	integer Search by time billable 0 = No 1 = Billable 2 = Billed
from	string <date-time> Search by min date
to	string <date-time> Search by max date
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 2,
"limit": 100,
"offset": 0
},
"data": [{"id": "735",
"id_user": "213",
"id_project": "435",
"id_project_task": "89",
"id_project_task_subtask": "",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"id_type": "8",
"billable": "0",
"billed_date": null,
"time_date": "2022-07-15",
"time_done": "01:30:00",
"time_planified": "02:00:00",
"description": "A description or note about this time",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a time.

Authorizations:

Bearer token

Request Body schema: application/json

id_user required	string User Id Email address can be used here
id_project	integer Project Id
id_project_task	integer Project task Id
id_project_task_subtask	integer Project subtask Id
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_ticketing_ticket	integer Ticket Id
id_type	integer Time type Id
billable	integer Billable time 0 = No 1 = Billable 2 = Billed
time_date	string <date-time> Time date
time_done	string Time done
time_planified	string Time planned
description	string Time descritpion

Responses

Request samples

Payload

Content type

application/json

{"id_user": 213,
"id_project": 435,
"id_project_task": 89,
"id_project_task_subtask": "",
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_ticketing_ticket": "",
"id_type": 8,
"billable": 0,
"time_date": "2022-07-15",
"time_done": "01:30",
"time_planified": "02:00",
"description": "A description or note about this time"
}

Response samples

200
400
401

Content type

application/json

{"id": "735",
"id_user": "213",
"id_project": "435",
"id_project_task": "89",
"id_project_task_subtask": "",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"id_type": "8",
"billable": "0",
"billed_date": null,
"time_date": "2022-07-15",
"time_done": "01:30:00",
"time_planified": "02:00:00",
"description": "A description or note about this time",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one time.

Authorizations:

Bearer token

path Parameters

id

required

integer

Time Id

Responses

Response samples

200
401

Content type

application/json

{"id": "735",
"id_user": "213",
"id_project": "435",
"id_project_task": "89",
"id_project_task_subtask": "",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"id_type": "8",
"billable": "0",
"billed_date": null,
"time_date": "2022-07-15",
"time_done": "01:30:00",
"time_planified": "02:00:00",
"description": "A description or note about this time",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a time.

Authorizations:

Bearer token

path Parameters

id

required

integer

Time Id

Request Body schema: application/json

id_user	string User Id Email address can be used here
id_project	integer Project Id
id_project_task	integer Project task Id
id_project_task_subtask	integer Project subtask Id
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_ticketing_ticket	integer Ticket Id
id_type	integer Time type Id
billable	integer Billable time 0 = No 1 = Billable 2 = Billed
time_date	string <date-time> Time date
time_done	string Time done
time_planified	string Time planned
description	string Time descritpion

Responses

Request samples

Payload

Content type

application/json

{"id_user": 213,
"id_project": 435,
"id_project_task": 89,
"id_project_task_subtask": "",
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_ticketing_ticket": "",
"id_type": 8,
"billable": 0,
"time_date": "2022-07-15",
"time_done": "01:30",
"time_planified": "02:00",
"description": "A description or note about this time"
}

Response samples

200
400
401

Content type

application/json

{"id": "735",
"id_user": "213",
"id_project": "435",
"id_project_task": "89",
"id_project_task_subtask": "",
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_ticketing_pipeline": "0",
"id_ticketing_ticket": "0",
"id_type": "8",
"billable": "0",
"billed_date": null,
"time_date": "2022-07-15",
"time_done": "01:30:00",
"time_planified": "02:00:00",
"description": "A description or note about this time",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a time.

Authorizations:

Bearer token

path Parameters

id

required

integer

Time Id

Responses

Response samples

200
400
401

Content type

application/json

null

Types

Get a list of all times types.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "7",
"title": "Commercial",
"title_en": "Commercial",
"title_es": "Comercial"
},
{"id": "8",
"title": "Support",
"title_en": "Support",
"title_es": "Soporte"
}
]
}

Projects

This section lists all project-related APIS.

List

Get a list of all projects.

Authorizations:

Bearer token

query Parameters

title	string Search by project title
id_customer_supplier	integer Search by customer Id or supplier Id
id_opportunity	integer Search by opportunity Id
id_status	integer Search by status Id
id_user_assigned	integer Search by user associated with the project
archived	integer Search by project condition 0 = Active 1 = Archived
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 14,
"limit": 100,
"offset": 0
},
"data": [{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "A tester"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a project.

Authorizations:

Bearer token

Request Body schema: application/json

title required	string Project title
columns	Array of strings[ items >= 2 ] List of columns
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
starting_date	string <date-time> Start date
due_date	string <date-time> Due date
id_status	integer Project status Id
id_user_assigned	string User Id associated with the project Email address can be used here Project manager
create_access_all_users	integer Create access to this project for all the users 0 = No (default) 1 = Yes
archived	integer Project condition 0 = Active 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"title": "Project #1",
"columns": ["Column #1",
"Column #2",
"Column #3"
],
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"id_status": 1,
"id_user_assigned": 213,
"create_access_all_users": 0,
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"archived": "0",
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one project.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a project.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

title	string Project title
columns	Array of strings[ items >= 2 ] List of columns
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
starting_date	string <date-time> Start date
due_date	string <date-time> Due date
id_status	integer Project status Id
id_user_assigned	string User Id associated with the task Email address can be used here Project manager
archived	integer Project condition 0 = Active 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"title": "Project #1",
"columns": ["Column #1, Column #2, Column #3"
],
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"id_status": 1,
"id_user_assigned": 213,
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a project.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

null

Access - Create/Update

Create or Update project access.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
user_id required	integer User Id

Request Body schema: application/json

is_admin	integer Admin of the project 0 = No (default) 1 = Yes
read_only	integer Read only 0 = No (default) 1 = Yes
access_only_if_assigned	integer Access to tasks only if assigned 0 = No (default) 1 = Yes
update_for_other	integer Can update for other 0 = No 1 = Yes (default)

Responses

Request samples

Payload

Content type

application/json

{"is_admin": 0,
"read_only": 0,
"access_only_if_assigned": 0,
"update_for_other": 1
}

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Access - Delete

Delete a user access to the project.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
user_id required	integer User Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Status

Get a list of all status.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "New"
},
{"id": "2",
"title": "Planned"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "Closed"
}
]
}

Custom fields

Get a list of all projects custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3483",
"title": "Priority",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of projects custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Project custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "6089",
"title": "Low"
},
{"id": "6090",
"title": "Medium"
},
{"id": "6091",
"title": "High"
}
]
}

Tasks - List

Get a list of all project tasks.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": "14",
"limit": "100",
"offset": "0"
},
"data": [{"id": "486",
"number": "1",
"column_number": "5",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"milestone": "0",
"status": "91",
"title": "Project task #1",
"description": "A description or note about this project task",
"priority": "0",
"color": "95a5a6",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"working_time": "0.00",
"estimation_time": "5.00",
"id_user_assigned": ["u213"
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_phase": "0",
"skills": [ ],
"custom_fields_list": [ ],
"nb_subtask": "0",
"nb_subtask_complete": "0",
"nb_comments": "0",
"nb_files": "0",
"nb_events": "0",
"nb_events_notes": "0",
"nb_events_tasks": "0",
"nb_conversations_emails": "0",
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Tasks - Create

Create a project task.

Authorizations:

Bearer token

path Parameters

id

required

integer

Request Body schema: application/json

title required	string Task title
column_number	integer Column number in the project
status	integer Task status Id
description	string Task descritpion
priority	integer Task priority Id
starting_date	string <date-time> Start date
due_date	string <date-time> Due date Working_time is not editable, this field is linked to times. Please add or edit times on this task to update working_time
estimation_time	string Time estimated
id_user_assigned	string User with group Id associated with the task For users, email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_phase	integer Task phase Id
archived	integer Project condition 0 = Active 1 = Archived
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Task #1",
"column_number": "1",
"status": 89,
"description": "A description or note about this task",
"priority": "0",
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"estimation_time": "2:00",
"id_user_assigned": "u213",
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_phase": 10,
"archived": 0,
"custom_fields": [{"id": 3383,
"value": 6089
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "486",
"number": "1",
"column_number": "5",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"milestone": "0",
"status": "91",
"title": "Project task #1",
"description": "A description or note about this project task",
"priority": "0",
"color": "95a5a6",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"working_time": "0.00",
"estimation_time": "5.00",
"id_user_assigned": ["u213"
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_phase": "0",
"skills": [ ],
"nb_subtask": "0",
"nb_subtask_complete": "0",
"nb_comments": "0",
"nb_files": "0",
"nb_events": "0",
"nb_events_notes": "0",
"nb_events_tasks": "0",
"nb_conversations_emails": "0",
"archived": "0",
"custom_fields_list": [{"id": "3483",
"title": "Priority",
"value": "6089",
"value_text": "Low"
}
],
"subtasks_list": [ ],
"comments_list": [ ],
"files_list": [ ],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Tasks - Show

Get one project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "486",
"number": "1",
"column_number": "5",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"milestone": "0",
"status": "91",
"title": "Project task #1",
"description": "A description or note about this project task",
"priority": "0",
"color": "95a5a6",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"working_time": "0.00",
"estimation_time": "5.00",
"id_user_assigned": ["u213"
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_phase": "0",
"skills": [ ],
"nb_subtask": "0",
"nb_subtask_complete": "0",
"nb_comments": "0",
"nb_files": "0",
"nb_events": "0",
"nb_events_notes": "0",
"nb_events_tasks": "0",
"nb_conversations_emails": "0",
"archived": "0",
"custom_fields_list": [{"id": "3483",
"title": "Priority",
"value": "6089",
"value_text": "Low"
}
],
"subtasks_list": [{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_date": "1:50",
"estimation_time": "3:00",
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}
],
"comments_list": [{"id": "56",
"comment": "<p>Comment #1</p>",
"creation_date": "2022-04-23 16:23:27",
"created_by": "213",
"update_date": "2022-04-23 16:25:38",
"updated_by": "213"
}
],
"files_list": [{"id": "21",
"name": "ticket.pdf",
"size": "64",
"download_url": "https://karlia.fr/...",
"creation_date": "2022-04-23 16:20:24",
"created_by": "213",
"update_date": "2022-04-23 16:29:31",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Tasks - Update

Update a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Request Body schema: application/json

title	string Task title
column_number	integer Column number in the project
status	integer Tasks status Id
description	string Task descritpion
priority	integer Task priority Id
starting_date	string <date-time> Start date
due_date	string <date-time> Due date Working_time is not editable, this field is linked to times. Please add or edit times on this task to update working_time
estimation_time	string Time estimated
id_user_assigned	string User with group Id associated with the task For users, email address can be used here
id_customer_supplier	integer Customer Id or supplier Id
id_opportunity	integer Opportunity Id
id_phase	integer Task phase Id
archived	integer Project condition 0 = Active 1 = Archived
	Array of objects Custom fields

Responses

Request samples

Payload

Content type

application/json

{"title": "Project #1",
"column_number": "1",
"status": 89,
"description": "A description or note about this task",
"priority": "0",
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"estimation_time": "2:00",
"id_user_assigned": "u213",
"id_customer_supplier": 28496,
"id_opportunity": 1985,
"id_phase": 10,
"archived": 0,
"custom_fields": [{"id": 3383,
"value": 6089
}
]
}

Response samples

200
400
401

Content type

application/json

{"id": "486",
"number": "1",
"column_number": "5",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"milestone": "0",
"status": "91",
"title": "Project task #1",
"description": "A description or note about this project task",
"priority": "0",
"color": "95a5a6",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"working_time": "0.00",
"estimation_time": "5.00",
"id_user_assigned": ["u213"
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_phase": "0",
"skills": [ ],
"nb_subtask": "0",
"nb_subtask_complete": "0",
"nb_comments": "0",
"nb_files": "0",
"nb_events": "0",
"nb_events_notes": "0",
"nb_events_tasks": "0",
"nb_conversations_emails": "0",
"archived": "0",
"custom_fields_list": [{"id": "3483",
"title": "Priority",
"value": "6089",
"value_text": "Low"
}
],
"subtasks_list": [{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_date": "1:50",
"estimation_time": "3:00",
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}
],
"comments_list": [{"id": "56",
"comment": "<p>Comment #1</p>",
"creation_date": "2022-04-23 16:23:27",
"created_by": "213",
"update_date": "2022-04-23 16:25:38",
"updated_by": "213"
}
],
"files_list": [{"id": "21",
"name": "ticket.pdf",
"size": "64",
"download_url": "https://karlia.fr/...",
"creation_date": "2022-04-23 16:20:24",
"created_by": "213",
"update_date": "2022-04-23 16:29:31",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Tasks - Delete

Delete a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Responses

Response samples

200
400
401

Content type

application/json

null

Tasks - Add/Update custom fields

Values of projects custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id
field_id required	integer Project custom field Id

Request Body schema: application/json

field_value

required

integer

Responses

Request samples

Payload

Content type

application/json

{"field_value": 6089
}

Response samples

200
400
401

Content type

application/json

{"id": "435",
"title": "Project #1",
"columns": [{"id": "1",
"title": "To do"
},
{"id": "2",
"title": "Pending"
},
{"id": "3",
"title": "In progress"
},
{"id": "4",
"title": "To test"
},
{"id": "5",
"title": "Completed"
}
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"id_status": "1",
"id_user_assigned": ["213"
],
"access_list": [{"id_user": "213",
"is_admin": "1",
"read_only": "0",
"access_only_if_assigned": "0",
"update_for_other": "1"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Tasks - Comments

Create a project task comment.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Request Body schema: application/json

id_user required	integer User Id
comment required	string Comment

Responses

Request samples

Payload

Content type

application/json

{"id_user": 213,
"comment": "Comment #1"
}

Response samples

200
400
401

Content type

application/json

{"id": "486",
"number": "1",
"column_number": "5",
"column_number_last_update": "2022-04-04 09:44:49",
"position": "1",
"milestone": "0",
"status": "91",
"title": "Project task #1",
"description": "A description or note about this project task",
"priority": "0",
"color": "95a5a6",
"starting_date": "2022-03-15 19:45:00",
"due_date": null,
"working_time": "0.00",
"estimation_time": "5.00",
"id_user_assigned": ["u213"
],
"id_customer_supplier": "28496",
"id_opportunity": "1985",
"id_phase": "0",
"skills": [ ],
"nb_subtask": "0",
"nb_subtask_complete": "0",
"nb_comments": "0",
"nb_files": "0",
"nb_events": "0",
"nb_events_notes": "0",
"nb_events_tasks": "0",
"nb_conversations_emails": "0",
"archived": "0",
"custom_fields_list": [{"id": "3483",
"title": "Priority",
"value": "6089",
"value_text": "Low"
}
],
"subtasks_list": [{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_date": "1:50",
"estimation_time": "3:00",
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}
],
"comments_list": [{"id": "56",
"comment": "<p>Comment #1</p>",
"creation_date": "2022-04-23 16:23:27",
"created_by": "213",
"update_date": "2022-04-23 16:25:38",
"updated_by": "213"
}
],
"files_list": [{"id": "21",
"name": "ticket.pdf",
"size": "64",
"download_url": "https://karlia.fr/...",
"creation_date": "2022-04-23 16:20:24",
"created_by": "213",
"update_date": "2022-04-23 16:29:31",
"updated_by": "213"
}
],
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Tasks - Status of all projects

Get a list of all status of all projects tasks.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "89",
"title": "En attente",
"title_en": "Pending",
"title_es": "Pendiente",
"status_type": "1",
"status_type_title": "En attente"
},
{"id": "90",
"title": "En cours",
"title_en": "In progress",
"title_es": "En curso",
"status_type": "2",
"status_type_title": "En cours"
},
{"id": "91",
"title": "Terminé",
"title_en": "Completed",
"title_es": "Completado",
"status_type": "3",
"status_type_title": "Terminé"
}
]
}

Tasks - Status of one project

Get a list of all status of one project task.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "89",
"title": "En attente",
"title_en": "Pending",
"title_es": "Pendiente",
"status_type": "1",
"status_type_title": "En attente"
},
{"id": "90",
"title": "En cours",
"title_en": "In progress",
"title_es": "En curso",
"status_type": "2",
"status_type_title": "En cours"
},
{"id": "91",
"title": "Terminé",
"title_en": "Completed",
"title_es": "Completado",
"status_type": "3",
"status_type_title": "Terminé"
}
]
}

Tasks - Phases

Get a list of all phases of project tasks.

Authorizations:

Bearer token

path Parameters

id

required

integer

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "10",
"title": "Phase #1",
"title_en": "Phase #1",
"title_es": "Fase #1",
"starting_date": "2022-04-11",
"due_date": "2022-04-15"
},
{"id": "11",
"title": "Phase #2",
"title_en": "Phase #2",
"title_es": "Fase #2",
"starting_date": "2022-04-18",
"due_date": "2022-04-22"
},
{"id": "12",
"title": "Phase #3",
"title_en": "Phase #3",
"title_es": "Fase #3",
"starting_date": "2022-04-25",
"due_date": "2022-04-29"
}
]
}

Tasks - Priorities

Get a list of all priorities.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "0",
"title": "Undefined"
},
{"id": "1",
"title": "Low"
},
{"id": "2",
"title": "Medium"
},
{"id": "3",
"title": "High"
}
]
}

Subtasks - List

Get a list of all subtasks of a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"pagination": {"total": "14",
"limit": "100",
"offset": "0"
},
"data": [{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_time": "1:50",
"estimation_time": "3:00",
"id_user_assigned": ["u213"
],
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}
]
}

Subtasks - Create

Create a subtask of a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id

Request Body schema: application/json

title required	string Project title
status	integer Subtask status Id
section	integer Nature of the subtask 0 = Subtask 1 = Section
starting_date	string <date-time> Start date
due_date	string <date-time> Due date Working_time is not editable, this field is linked to times. Please add or edit times on this task to update working_time
estimation_time	string Time estimated
id_user_assigned	string User with group Id associated with the task For users, email address can be used here

Responses

Request samples

Payload

Content type

application/json

{"title": "Subtask #1",
"status": 89,
"section": 0,
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"estimation_time": "2:00",
"id_user_assigned": "u213"
}

Response samples

200
400
401

Content type

application/json

{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_time": "1:50",
"estimation_time": "3:00",
"id_user_assigned": ["u213"
],
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}

Subtasks - Show

Get one subtask of a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id
subtask_id required	integer Subtask of a project task Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_time": "1:50",
"estimation_time": "3:00",
"id_user_assigned": ["u213"
],
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}

Subtasks - Update

Update a subtask of a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id
subtask_id required	integer Subtask of a project task Id

Request Body schema: application/json

title	string Project title
status	integer Tasks status Id
section	integer Nature of the subtask 0 = Subtask 1 = Section
starting_date	string <date-time> Start date
due_date	string <date-time> Due date Working_time is not editable, this field is linked to times. Please add or edit times on this task to update working_time
estimation_time	string Time estimated
id_user_assigned	string User with group Id associated with the task For users, email address can be used here

Responses

Request samples

Payload

Content type

application/json

{"title": "Project #1",
"status": 89,
"section": 0,
"starting_date": "2022-07-01 12:00:00",
"due_date": "2022-09-31 00:00:00",
"estimation_time": "2:00",
"id_user_assigned": "u213"
}

Response samples

200
400
401

Content type

application/json

{"id": "1375",
"status": "89",
"section": "0",
"title": "Subtask #1",
"starting_date": "2022-04-23",
"due_date": null,
"working_time": "1:50",
"estimation_time": "3:00",
"id_user_assigned": ["u213"
],
"skills": [ ],
"creation_date": "2022-04-23 16:22:58",
"created_by": "213",
"update_date": "2022-04-23 16:22:58",
"updated_by": "213"
}

Subtasks - Delete

Delete a subtask of a project task.

Authorizations:

Bearer token

path Parameters

id required	integer Project Id
task_id required	integer Project task Id
subtask_id required	integer Subtask of a project task Id

Responses

Response samples

200
400
401

Content type

application/json

null

Ticketing

This section lists all ticket-related APIS.

List

Get a list of all tickets.

Authorizations:

Bearer token

query Parameters

pipeline	integer Search by pipeline Id
title	string Search by title
id_type	integer Search by type Id
id_status	integer Search by status Id
id_priority	integer Search by priority Id
id_group	integer Search by group Id
id_user_assigned	integer Search by user Id
skills	integer Search by skill Id
id_customer_supplier	integer Search by customer Id or supplier Id
id_customer_supplier_contact	integer Search by contact Id
id_opportunity	integer Search by opportunity Id
id_project	integer Search by project Id
id_project_task	integer Search by project task Id
id_equipment	integer Search by Equipment Id
archived	integer Search by status 0 = Not archived 1 = Archived
fields	string List of fields to be returned. By default, all fields are returned. Each field must be separated by a comma without space.
order	string <= 64 characters Name of the field to sort on
direction	string <= 4 characters Direction for sorting ASC = Ascending, from A to Z. DESC = Descending, from Z to A.
limit	integer Default: 100 Number of objects to be returned for paging
offset	integer Default: 0 Offset for paging

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"pagination": {"total": 3,
"limit": 100,
"offset": 0
},
"data": [{"id": "42",
"pipeline": "8",
"number": "1",
"id_type": "31",
"id_status": "1",
"id_status_last_update": "2022-05-23 09:37:49",
"position": "1",
"title": "Ticket #1",
"id_priority": "1",
"id_group": "18",
"id_user_assigned": "213",
"list_id_user_shared": [ ],
"description": "A description or note about this ticket",
"id_customer_supplier": "28496",
"id_customer_supplier_contact": "48560",
"id_opportunity": "1985",
"id_project": "435",
"id_project_task": "486",
"id_equipment": "1",
"skills": ["52"
],
"date_first_answer_expected": null,
"date_first_answer_real": null,
"date_resolve_answer_expected": null,
"date_resolve_answer_real": null,
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3526",
"title": "Client satisfaction",
"value": "6144",
"value_text": "Low"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}
]
}

Create

Create a ticket.

Authorizations:

Bearer token

Request Body schema: application/json

pipeline	integer pipeline Id
title	string Ticket title
id_type	integer Ticket type Id
id_status	integer Ticket status Id
id_priority	integer Priority Id
id_group	integer Group Id
id_user_assigned	integer User Id
skills	integer Skill Id
id_customer_supplier	integer Customer Id or supplier Id
id_customer_supplier_contact	integer Contact Id
id_opportunity	integer Opportunity Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_equipment	integer Equipment Id
list_id_user_shared	integer User shared Id
	Array of objects Custom fields
archived	integer Ticket status 0 = Not archived 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"pipeline": 42,
"title": "Ticket #1",
"id_type": 31,
"id_status": 1,
"id_priority": 1,
"id_group": 18,
"id_user_assigned": 213,
"skills": 52,
"id_customer_supplier": 28496,
"id_customer_supplier_contact": 48560,
"id_opportunity": 1985,
"id_project": 435,
"id_project_task": 486,
"id_equipment": "1",
"list_id_user_shared": null,
"custom_fields": [{"id": 3526,
"value": 6144
}
],
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "42",
"pipeline": "8",
"number": "1",
"id_type": "31",
"id_status": "1",
"id_status_last_update": "2022-05-23 09:37:49",
"position": "1",
"title": "Ticket #1",
"id_priority": "1",
"id_group": "18",
"id_user_assigned": "213",
"list_id_user_shared": [ ],
"description": "A description or note about this ticket",
"id_customer_supplier": "28496",
"id_customer_supplier_contact": "48560",
"id_opportunity": "1985",
"id_project": "435",
"id_project_task": "486",
"id_equipment": "1",
"skills": ["52"
],
"date_first_answer_expected": null,
"date_first_answer_real": null,
"date_resolve_answer_expected": null,
"date_resolve_answer_real": null,
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3526",
"title": "Client satisfaction",
"value": "6144",
"value_text": "Low"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Show

Get one ticket.

Authorizations:

Bearer token

path Parameters

id

required

integer

Ticket Id

Responses

Response samples

200
400
401

Content type

application/json

{"id": "42",
"pipeline": "8",
"number": "1",
"id_type": "31",
"id_status": "1",
"id_status_last_update": "2022-05-23 09:37:49",
"position": "1",
"title": "Ticket #1",
"id_priority": "1",
"id_group": "18",
"id_user_assigned": "213",
"list_id_user_shared": [ ],
"description": "A description or note about this ticket",
"id_customer_supplier": "28496",
"id_customer_supplier_contact": "48560",
"id_opportunity": "1985",
"id_project": "435",
"id_project_task": "486",
"id_equipment": "1",
"skills": ["52"
],
"date_first_answer_expected": null,
"date_first_answer_real": null,
"date_resolve_answer_expected": null,
"date_resolve_answer_real": null,
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3526",
"title": "Client satisfaction",
"value": "6144",
"value_text": "Low"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Update

Update a ticket.

Authorizations:

Bearer token

path Parameters

id

required

integer

Ticket Id

Request Body schema: application/json

title	string Ticket title
id_type	integer Ticket type Id
id_status	integer Ticket status Id
id_priority	integer Priority Id
id_group	integer Group Id
id_user_assigned	integer User Id
skills	integer Skill Id
id_customer_supplier	integer Customer Id or supplier Id
id_customer_supplier_contact	integer Contact Id
id_opportunity	integer Opportunity Id
id_project	integer Project Id
id_project_task	integer Project task Id
id_equipment	integer Equipment Id
list_id_user_shared	integer User shared Id
	Array of objects Custom fields
archived	integer Ticket status 0 = Not archived 1 = Archived

Responses

Request samples

Payload

Content type

application/json

{"title": "Ticket #1",
"id_type": 31,
"id_status": 1,
"id_priority": 1,
"id_group": 18,
"id_user_assigned": 213,
"skills": 52,
"id_customer_supplier": 28496,
"id_customer_supplier_contact": 48560,
"id_opportunity": 1985,
"id_project": 435,
"id_project_task": 486,
"id_equipment": "1",
"list_id_user_shared": null,
"custom_fields": [{"id": 3526,
"value": 6144
}
],
"archived": 0
}

Response samples

200
400
401

Content type

application/json

{"id": "42",
"pipeline": "8",
"number": "1",
"id_type": "31",
"id_status": "1",
"id_status_last_update": "2022-05-23 09:37:49",
"position": "1",
"title": "Ticket #1",
"id_priority": "1",
"id_group": "18",
"id_user_assigned": "213",
"list_id_user_shared": [ ],
"description": "A description or note about this ticket",
"id_customer_supplier": "28496",
"id_customer_supplier_contact": "48560",
"id_opportunity": "1985",
"id_project": "435",
"id_project_task": "486",
"id_equipment": "1",
"skills": ["52"
],
"date_first_answer_expected": null,
"date_first_answer_real": null,
"date_resolve_answer_expected": null,
"date_resolve_answer_real": null,
"creation_source": "3",
"creation_source_title": "API",
"custom_fields_list": [{"id": "3526",
"title": "Client satisfaction",
"value": "6144",
"value_text": "Low"
}
],
"archived": "0",
"creation_date": "2022-03-25 12:04:24",
"created_by": "213",
"update_date": "2022-03-25 12:04:24",
"updated_by": "213"
}

Delete

Delete a ticket.

Authorizations:

Bearer token

path Parameters

id

required

integer

Ticket Id

Responses

Response samples

200
400
401

Content type

application/json

null

Pipelines

Get a list of all pipelines.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "8",
"title": "Pipeline #1"
}
]
}

Pipeline types

Get types of a pipeline.

Authorizations:

Bearer token

path Parameters

pipeline_id

required

integer

Pipeline Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "30",
"title": "Incident",
"title_en": "Incident",
"title_es": "Incidente",
"customer_title": "Incident",
"customer_title_en": "Incident",
"customer_title_es": "Incidente"
},
{"id": "31",
"title": "Bug",
"title_en": "Bug",
"title_es": "Bug",
"customer_title": "Bug",
"customer_title_en": "Bug",
"customer_title_es": "Bug"
},
{"id": "32",
"title": "Demande d'amélioration",
"title_en": "Request for improvement",
"title_es": "Solicitud de mejora",
"customer_title": "Demande d'amélioration",
"customer_title_en": "Request for improvement",
"customer_title_es": "Solicitud de mejora"
}
]
}

Pipeline status

Get status of a pipeline.

Authorizations:

Bearer token

path Parameters

pipeline_id

required

integer

Pipeline Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "En attente",
"title_en": "Pending",
"title_es": "En espera",
"customer_title": "En attente",
"customer_title_en": "Pending",
"customer_title_es": "En espera"
},
{"id": "2",
"title": "En cours",
"title_en": "In progress",
"title_es": "En progreso",
"customer_title": "En cours",
"customer_title_en": "In progress",
"customer_title_es": "En progreso"
},
{"id": "3",
"title": "Cloturé",
"title_en": "Closed",
"title_es": "Cerrado",
"customer_title": "Cloturé",
"customer_title_en": "Closed",
"customer_title_es": "Cerrado"
}
]
}

Priorities

Get a list of all priorities.

Authorizations:

Bearer token

Responses

Response samples

200
401

Content type

application/json

{"status": "success",
"data": [{"id": "1",
"title": "Urgent"
},
{"id": "2",
"title": "High"
},
{"id": "3",
"title": "Medium"
},
{"id": "4",
"title": "Low"
}
]
}

Custom fields

Get a list of all ticketing custom fields.

Authorizations:

Bearer token

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "3526",
"title": "Client satisfaction",
"type": "Dropdown list",
"with_values": "true"
}
]
}

Custom field values

Get values of ticketing custom field.

Authorizations:

Bearer token

path Parameters

field_id

required

integer

Ticketing custom field Id

Responses

Response samples

200
400
401

Content type

application/json

{"status": "success",
"data": [{"id": "6144",
"title": "Low"
},
{"id": "6145",
"title": "Medium"
},
{"id": "6146",
"title": "High"
}
]
}

Add/Update custom fields

Values of ticketing custom field.

Authorizations:

Bearer token

path Parameters

id required	integer Ticket Id
field_id required	integer Ticket custom field Id

Request Body schema: application/json

field_value

required

integer