Logo Karlia
API docs by Redocly

API Documentation

Download OpenAPI specification:Download

E-mail: contact@karlia.com URL: https://karlia.fr

Introduction

Welcome to the Karlia API documentation !

Karlia is a powerful CRM platform that brings together everything you need to better optimize your productivity in one easy-to-use tool.

The Karlia API is built around a RESTful architecture and allows you to customize, modify and integrate your Karlia organization and external services.

Quotas

A limit on the number of requests per minute (100 requests / minutes) and month (depend of your subscription) is applied to each account.

A 429 error will be sent if at least one of the quotas has reached zero.

The quotas are counted on each request, even for errors.

Customers

This section lists all customer-related APIs.

List

Get a list of all customers.

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.

name
integer <= 127 characters

Search by name

prospect
integer

Search by status

0 = Client
1 = Prospect

individual
integer

Search by type

0 = Professional
1 = Individual

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 Id associated with the customer

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

Create

Create a customer.

Authorizations:
Bearer token
Request Body schema: application/json
name
required
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
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

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": [
    ],
  • "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

Content type
application/json
{
  • "id": "28496",
  • "title": "Society X",
  • "individual": "0",
  • "prospect": "0",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [ ],
  • "custom_fields_list": [
    ],
  • "opportunities_list": [ ],
  • "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": [
    ],
  • "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 customer.

Authorizations:
Bearer token
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": "28496",
  • "title": "Society X",
  • "individual": "0",
  • "prospect": "0",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "opportunities_list": [
    ],
  • "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": [
    ],
  • "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
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

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": [
    ],
  • "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

Content type
application/json
{
  • "id": "28496",
  • "title": "Society X",
  • "individual": "0",
  • "prospect": "0",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "opportunities_list": [
    ],
  • "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": [
    ],
  • "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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Add/Update custom field

Add or update a customer custom field.

Authorizations:
Bearer token
path Parameters
id
required
integer
field_id
required
integer

Customer custom field Id

Request Body schema: application/json
field_value
required

Responses

Request samples

Content type
application/json
{
  • "field_value": 5900
}

Response samples

Content type
application/json
{
  • "id": "28496",
  • "title": "Society X",
  • "individual": "0",
  • "prospect": "0",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "opportunities_list": [
    ],
  • "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": [
    ],
  • "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

Content type
application/json
{
  • "upload_file_content": "",
  • "upload_file_url": "",
  • "upload_file_name": ""
}

Response samples

Content type
application/json
{
  • "id": "28496",
  • "title": "Society X",
  • "individual": "0",
  • "prospect": "0",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "opportunities_list": [
    ],
  • "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": [
    ],
  • "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
file_id
required
integer

File Id

Responses

Response samples

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

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": [
    ],
  • "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

Content type
application/json
{
  • "id": "48560",
  • "title": "Society Y",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [ ],
  • "custom_fields_list": [
    ],
  • "files_list": [
    ],
  • "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

Content type
application/json
{
  • "id": "48560",
  • "title": "Society Y",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "files_list": [
    ],
  • "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
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

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": [
    ],
  • "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

Content type
application/json
{
  • "id": "48560",
  • "title": "Society Y",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "files_list": [
    ],
  • "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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Add/Update custom field

Add or update a supplier custom field.

Authorizations:
Bearer token
path Parameters
id
required
integer
field_id
required
integer

Supplier custom field Id

Request Body schema: application/json
field_value
required

Responses

Request samples

Content type
application/json
{
  • "field_value": 5911
}

Response samples

Content type
application/json
{
  • "id": "48560",
  • "title": "Society Y",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "files_list": [
    ],
  • "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

Content type
application/json
{
  • "upload_file_content": "",
  • "upload_file_url": "",
  • "upload_file_name": ""
}

Response samples

Content type
application/json
{
  • "id": "48560",
  • "title": "Society Y",
  • "id_client_manager": [
    ],
  • "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": [
    ],
  • "contacts_list": [
    ],
  • "custom_fields_list": [
    ],
  • "files_list": [
    ],
  • "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
file_id
required
integer

File Id

Responses

Response samples

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

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": [
    ]
}

Response samples

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": [
    ],
  • "client_portal": {
    },
  • "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

Responses

Response samples

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": [
    ],
  • "client_portal": {
    },
  • "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
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

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": [
    ]
}

Response samples

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": [
    ],
  • "client_portal": {
    },
  • "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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Add/Update custom field

Add or update a contact custom field.

Authorizations:
Bearer token
path Parameters
id
required
integer
field_id
required
integer

Contact custom field Id

Request Body schema: application/json
field_value
required

Responses

Request samples

Content type
application/json
{
  • "field_value": 5994
}

Response samples

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": [
    ],
  • "client_portal": {
    },
  • "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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

Create

Create an opportunity.

Authorizations:
Bearer token
Request Body schema: application/json
pipeline
required
integer
id_customer
required
integer
title
string <= 127 characters

Opportunity title

column_number
integer
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

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": [
    ]
}

Response samples

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": [
    ],
  • "id_user_assigned_text": [
    ],
  • "color": "#ff0000",
  • "archived": "0",
  • "custom_fields_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"
}

Show

Get one opportunity.

Authorizations:
Bearer token
path Parameters
id
required
integer

Responses

Response samples

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": [
    ],
  • "id_user_assigned_text": [
    ],
  • "color": "#ff0000",
  • "archived": "0",
  • "custom_fields_list": [
    ],
  • "proposals": [
    ],
  • "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
id_customer
integer
title
string <= 127 characters

Opportunity title

column_number
integer
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

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": [
    ]
}

Response samples

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": [
    ],
  • "id_user_assigned_text": [
    ],
  • "color": "#ff0000",
  • "archived": "0",
  • "custom_fields_list": [
    ],
  • "proposals": [
    ],
  • "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

Content type
application/json
null

Custom fields

Get a list of all opportunities custom fields.

Authorizations:
Bearer token

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Add/Update custom field

Add or update a opportunity custom field.

Authorizations:
Bearer token
path Parameters
id
required
integer
field_id
required
integer

Opportunity custom field Id

Request Body schema: application/json
field_value
required

Responses

Request samples

Content type
application/json
{
  • "field_value": 5995
}

Response samples

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": [
    ],
  • "id_user_assigned_text": [
    ],
  • "color": "#ff0000",
  • "archived": "0",
  • "custom_fields_list": [
    ],
  • "proposals": [
    ],
  • "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

Content type
application/json
{
  • "id_proposal": "0",
  • "upload_file_content": "",
  • "upload_file_url": "",
  • "upload_file_name": ""
}

Response samples

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": [
    ],
  • "id_user_assigned_text": [
    ],
  • "color": "#ff0000",
  • "archived": "0",
  • "custom_fields_list": [
    ],
  • "proposals": [
    ],
  • "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
file_id
required
integer

File Id

Responses

Response samples

Content type
application/json
null

Pipelines

Get a list of all opportunities pipelines.

Authorizations:
Bearer token

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Pipelines columns

Get opportunities pipeline columns.

Authorizations:
Bearer token
path Parameters
pipeline_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Status

Get a list of all status.

Authorizations:
Bearer token

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Status lost

Get a list of all lost statuses.

Authorizations:
Bearer token

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Status canceled

Get a list of all canceled statuses.

Authorizations:
Bearer token

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

Content type
application/json
{
  • "status": "success",
  • "pagination": {
    },
  • "data": [
    ]
}

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

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": [
    ]
}

Response samples

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": [
    ],
  • "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

Responses

Response samples

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": [