Skip to content

ACHAT

Généralités

Les entités et endpoints décrits ci-dessous ne sont pas une liste exhaustive. Ils ne représentent que les plus couramment utilisés.

Veuillez vous référer au chapitre USAGE pour en savoir plus.

Remarque

Les paramètres énumérés pour les requêtes "POST" sont uniquement des exemples de paramètres obligatoires. Ils varient selon le sous-domaine utilisé.

L'ensemble des paramètres sont disponibles dans la section "Attributes" de chaque entité

Chemin

Pour accéder à votre API depuis un compte en production vous devez utiliser le chemin suivant : 

https://<account_subdomain>.nicoka.com/api/
Si vous souhaitez tester l’API depuis un compte d’essai vous devez utiliser le chemin suivant : 
https://trial.nicoka.com/<account_subdomain>/api/

Note

<account_subdomain> désigne le nom de votre sous-domaine Nicoka

Connexion à l'API

Voir le chapitre Connexion à l'API

Valeurs des listes déroulantes

Dans cette page, vous trouverez les principales entités et endpoints nécesssaires.
La valeur de certains attributs sont disponibles dans Nicoka sous forme de liste. Cette liste est :

  • soit disponible depuis le endpoint référencé directement sous l'attribut
  • soit reliée à une entité décrite dans cette documentation API
Exemple 1 : Endpoint référencé directement sous l'attribut

source int (Liste déroulante : Provenance)
Provenance de la candidature
Endpoint de récupération des valeurs: /application/entities/462/values/

La liste des valeurs possibles pour source est disponible à cet url:

  • https://<account_subdomain>.nicoka.com/api/application/entities/462/values/ pour un compte en production
  • https://trial.nicoka.com/<account_subdomain>/api/application/entities/462/values/ pour compte d'essai
Exemple 2 : Endpoint relié à une entité décrite dans cette documentation

candidateid int (Liste déroulante : Candidat)
Candidat

cliquer sur le lien Liste déroulante : Candidat à côté de l'attribut. Vous serez redirigé vers l'entité correspondante,ici l'entité Candidat.
Vous pourrez alors obtenir la Liste des candidats avec le endpoint correspondant GET /candidates.

Fournisseur

Overview

Attributes

supplierid int
ID Système

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/301/values/

status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/302/values/

compid int (Liste déroulante : Société)
Société

picture string
Logo

name1 string
Nom

name2 string
Nom (Suite)

reference string
Code

email string (CHAR255)
Email

external_reference string
Réf. Externe

phone string (CHAR35)
Téléphone

phone2 string (CHAR35)
Téléphone 2

fax string (CHAR35)
Fax

communication_language int (Liste déroulante : Langue)
Langue
Endpoint de récupération des valeurs: /application/entities/14/values/

website string (CHAR255)
Site Web

legal_form string
Forme juridique

capital string
Capital

identification_number string
SIRET

trade_reg_number string
RCS

trade_reg_location string
RC Lieux

vat_reg_number string
Numéro de TVA

account_number string
N° compte

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/

cnk_certificate_reference string
SCN/CSQ N°

expense_accountid int (Liste déroulante : Compte Comptable)
Compte de charge par défaut
Endpoint de récupération des valeurs: /accounts

payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/

vatid int (Liste déroulante : Taux de TVA)
Taux de TVA
Endpoint de récupération des valeurs: /application/entities/1608/values/

comments longtext
Commentaires

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

assignment_type int
Visible par

owner_entityid int (Liste déroulante : Entité)
Propriétaire (Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

owner_objectid int (Liste déroulante : Collaborateur)
Assigné à

main_contactid int (Liste déroulante : Contact)
Contact Principal

commercial_contactid int (Liste déroulante : Contact)
Contact Commercial

support_contactid int (Liste déroulante : Contact)
Contact Support

invoicing_contactid int (Liste déroulante : Contact)
Contact Facturation

nb_of_open_tasks int
Nb. de tâches en cours

bank_account_owner string
Titulaire du compte

bank_name string
Nom de la banque

nb_of_tasks int
Nb. de tâches

swift string
Code BIC/Swift

iban string
IBAN

last_activityid int (Liste déroulante : Activité)
Dernière action

bulkid int (Liste déroulante : Log import)
Log import
Endpoint de récupération des valeurs: /application/entities/41/values/

bank_account_number string
N° de compte bancaire

cdate datetime
Créé le

last_invoice_date date
Date de la dernière facture

first_invoice_date date
Date de première facture

cname int (Liste déroulante : Utilisateur)
Créé par

udate datetime
MàJ le

payment_notes string (TEXT)
Info. de paiement

uname int (Liste déroulante : Utilisateur)
MàJ par

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/

zipcode string
Code Postal

profitcenters longtext (multiple)
Centres de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

city string
Ville

country int (Liste déroulante : Pays)
Pays
Endpoint de récupération des valeurs: /application/entities/13/values/

tags longtext (multiple)
Tags
Endpoint de récupération des valeurs: /application/entities/313/values/

last_email_sent_on datetime
Dernier e-mail envoyé le

last_email_received_on datetime
Dernier e-mail reçu le

last_phone_call_on datetime
Dernier appel le

last_phone_successful_call_on datetime
Dernier appel réussi le

nb_of_contacts int
Nb. de contacts

last_meeting_on datetime
Dernier meeting le

last_action_by_userid int (Liste déroulante : Utilisateur)
Dernière action effectué par

ENDPOINTS

Liste des fournisseurs

REQUEST

GET /suppliers

RESPONSE

200 OK

{
    "queryUid": "204cc56ca8fb24df219802f043840956",
    "offset": 0,
    "limit": 3,
    "page": 1,
    "pages": 1,
    "total": 3,
    "data": [
        {
            "id": 118,
            "supplierid": 118,
            "type": 1,
            "parentid": null,
            "companyid": null,
            "status": 2,
            "compid": 1,
            "main_contactid": null,
            "commercial_contactid": null,
            "support_contactid": null,
            "ordering_contactid": null,
            "invoicing_contactid": null,
            "dunning_contactid": null,
            "reference": "",
            "external_reference": null,
            "title": null,
            "keyname": "macif-macif-sa-79000",
            "name1": "MACIF",
            "name2": "MACIF (SA)",
            "name3": null,
            "name4": null,
            "email": "",
            "phone": null,
            "phone2": null,
            "fax": null,
            "communication_language": "fr",
            "zipcode": "79000",
            "city": "Niort",
            "country": "FR",
            "lat": "46.3250000",
            "lng": "-0.4622200",
            "areaid": 1863,
            "area_level": 7,
            "area_lvl1": 4,
            "area_lvl2": 21,
            "area_lvl3": 681,
            "area_lvl4": 746,
            "area_lvl5": 755,
            "area_lvl6": 944,
            "area_lvl7": 1863,
            "industry": null,
            "website": "",
            "picture": null,
            "assignment_type": 1,
            "assignment_targets": "[{\"eid\":101,\"id\":43,\"r\":1,\"d\":1}]",
            "owner_entityid": 101,
            "owner_objectid": 43,
            "timezone": null,
            "working_hours": null,
            "day_duration_in_hours": null,
            "holidays_country": null,
            "legal_form": "Société d'assurance à forme mutuelle",
            "capital": "",
            "identification_number": "78145251100814",
            "trade_reg_number": "",
            "trade_reg_location": "",
            "vat_reg_number": "FR47781452511",
            "cnk_certificate_reference": null,
            "accountid": null,
            "account_number": null,
            "payment_mode": null,
            "payment_conditionid": null,
            "expense_accounts": null,
            "expense_accountid": null,
            "costcenterid": null,
            "costcenters": null,
            "profitcenterid": null,
            "profitcenters": null,
            "vat_rates": null,
            "vatid": null,
            "currency": "EUR",
            "bank_account_owner": "",
            "bank_name": "",
            "bank_account_number": "",
            "swift": "",
            "iban": null,
            "first_contact_on": null,
            "last_contact_date": null,
            "last_activityid": null,
            "last_email_sent_on": null,
            "last_email_received_on": null,
            "last_phone_call_on": null,
            "last_phone_successful_call_on": null,
            "last_meeting_on": null,
            "last_meeting_minute_on": null,
            "last_note_on": null,
            "last_action_on": null,
            "last_action_by_userid": null,
            "taskid": null,
            "nb_of_open_tasks": null,
            "nb_of_tasks": null,
            "first_invoice_date": null,
            "last_invoice_date": null,
            "ocr_scan_modelid": null,
            "date_format": null,
            "number_format": null,
            "rate_format": null,
            "payment_notes": "",
            "tags": null,
            "comments": null,
            "active": 1,
            "nb_of_contacts": 0,
            "indexing_status": 0,
            "loekz": 0,
            "cdate": "2025-07-07 14:58:47",
            "cname": 46,
            "udate": "2025-07-07 14:58:47",
            "uname": 46,
            "versi": 1,
            "label": "MACIF"
        },
        {
            "id": 117,
            "supplierid": 117,
            "type": 1,
            "parentid": null,
            "companyid": null,
            "status": 2,
            "compid": 1,
            "main_contactid": null,
            "commercial_contactid": null,
            "support_contactid": null,
            "ordering_contactid": null,
            "invoicing_contactid": null,
            "dunning_contactid": null,
            "reference": "",
            "external_reference": null,
            "title": null,
            "keyname": "relais-fnac-relais-fnac-49100",
            "name1": "RELAIS FNAC",
            "name2": "RELAIS FNAC",
            "name3": null,
            "name4": null,
            "email": "",
            "phone": null,
            "phone2": null,
            "fax": null,
            "communication_language": "fr",
            "zipcode": "49100",
            "city": "Angers",
            "country": "FR",
            "lat": "47.4768374",
            "lng": "-0.5561260",
            "areaid": 2289,
            "area_level": 8,
            "area_lvl1": 4,
            "area_lvl2": 21,
            "area_lvl3": 681,
            "area_lvl4": 744,
            "area_lvl5": 759,
            "area_lvl6": 897,
            "area_lvl7": 2233,
            "industry": null,
            "website": "",
            "picture": null,
            "assignment_type": 1,
            "assignment_targets": "[{\"eid\":101,\"id\":43,\"r\":1,\"d\":1}]",
            "owner_entityid": 101,
            "owner_objectid": 43,
            "timezone": null,
            "working_hours": null,
            "day_duration_in_hours": null,
            "holidays_country": null,
            "legal_form": "Société en nom collectif",
            "capital": "",
            "identification_number": "38803705300013",
            "trade_reg_number": "",
            "trade_reg_location": "",
            "vat_reg_number": "FR9388037053",
            "cnk_certificate_reference": null,
            "accountid": null,
            "account_number": null,
            "payment_mode": 3,
            "payment_conditionid": null,
            "expense_accounts": null,
            "expense_accountid": null,
            "costcenterid": null,
            "costcenters": null,
            "profitcenterid": null,
            "profitcenters": null,
            "vat_rates": null,
            "vatid": null,
            "currency": "EUR",
            "bank_account_owner": "",
            "bank_name": "",
            "bank_account_number": "",
            "swift": "",
            "iban": null,
            "first_contact_on": null,
            "last_contact_date": null,
            "last_activityid": 1471420,
            "last_email_sent_on": null,
            "last_email_received_on": null,
            "last_phone_call_on": null,
            "last_phone_successful_call_on": null,
            "last_meeting_on": "2025-01-23 16:45:00",
            "last_meeting_minute_on": "2025-01-23 16:50:00",
            "last_note_on": "2025-01-23 16:48:20",
            "last_action_on": "2025-01-23 16:50:00",
            "last_action_by_userid": 46,
            "taskid": null,
            "nb_of_open_tasks": null,
            "nb_of_tasks": null,
            "first_invoice_date": null,
            "last_invoice_date": null,
            "ocr_scan_modelid": null,
            "date_format": null,
            "number_format": null,
            "rate_format": null,
            "payment_notes": "",
            "tags": null,
            "comments": null,
            "active": 1,
            "nb_of_contacts": 0,
            "indexing_status": 0,
            "loekz": 0,
            "cdate": "2024-11-04 09:14:14",
            "cname": 46,
            "udate": "2025-01-23 16:50:22",
            "uname": 46,
            "versi": 4,
            "label": "RELAIS FNAC"
        }
    ]
}

Créer un nouveau fournisseur

REQUEST

POST /suppliers

{
    "name1": "SNCF"
}

RESPONSE

200 OK

{
    "success": "Fournisseur <b>SNCF</b> a été ajouté",
    "object": {
        "id": "120",
        "label": "SNCF",
        "supplierid": "120",
        "type": 1,
        "parentid": null,
        "companyid": null,
        "status": 1,
        "compid": null,
        "main_contactid": null,
        "commercial_contactid": null,
        "support_contactid": null,
        "ordering_contactid": null,
        "invoicing_contactid": null,
        "dunning_contactid": null,
        "reference": null,
        "external_reference": null,
        "title": null,
        "keyname": "sncf",
        "name1": "SNCF",
        "name2": null,
        "name3": null,
        "name4": null,
        "email": null,
        "phone": null,
        "phone2": null,
        "fax": null,
        "communication_language": null,
        "zipcode": null,
        "city": null,
        "country": null,
        "lat": null,
        "lng": null,
        "areaid": null,
        "area_level": null,
        "area_lvl1": null,
        "area_lvl2": null,
        "area_lvl3": null,
        "area_lvl4": null,
        "area_lvl5": null,
        "area_lvl6": null,
        "area_lvl7": null,
        "industry": null,
        "website": null,
        "picture": null,
        "assignment_type": 1,
        "assignment_targets": "[{\"eid\":1,\"id\":54,\"r\":1,\"d\":1}]",
        "owner_entityid": 1,
        "owner_objectid": 54,
        "timezone": null,
        "working_hours": null,
        "day_duration_in_hours": null,
        "holidays_country": null,
        "legal_form": null,
        "capital": null,
        "identification_number": null,
        "trade_reg_number": null,
        "trade_reg_location": null,
        "vat_reg_number": null,
        "cnk_certificate_reference": null,
        "accountid": null,
        "account_number": null,
        "payment_mode": null,
        "payment_conditionid": null,
        "expense_accounts": null,
        "expense_accountid": null,
        "costcenterid": null,
        "costcenters": null,
        "profitcenterid": null,
        "profitcenters": null,
        "vat_rates": null,
        "vatid": null,
        "currency": null,
        "bank_account_owner": null,
        "bank_name": null,
        "bank_account_number": null,
        "swift": null,
        "iban": null,
        "first_contact_on": null,
        "last_contact_date": null,
        "last_activityid": null,
        "last_email_sent_on": null,
        "last_email_received_on": null,
        "last_phone_call_on": null,
        "last_phone_successful_call_on": null,
        "last_meeting_on": null,
        "last_meeting_minute_on": null,
        "last_note_on": null,
        "last_action_on": null,
        "last_action_by_userid": null,
        "taskid": null,
        "nb_of_open_tasks": null,
        "nb_of_tasks": null,
        "first_invoice_date": null,
        "last_invoice_date": null,
        "ocr_scan_modelid": null,
        "date_format": null,
        "number_format": null,
        "rate_format": null,
        "payment_notes": null,
        "tags": null,
        "comments": null,
        "active": true,
        "nb_of_contacts": 0,
        "indexing_status": 0,
        "loekz": 0,
        "cdate": "2025-09-15 14:47:31",
        "cname": 54,
        "udate": "2025-09-15 14:47:31",
        "uname": 54,
        "versi": 1,
        "owner_label": "API api",
        "updateLink": "?route=suppliers/main&supplierid=120"
    }
}

Récupérer un fournisseur

Path params

Supplierid (int)
Identifiant d'un fournisseur

REQUEST

GET /suppliers/{supplierid}

RESPONSE

200 OK

{
  "id": 117,
  "label": "RELAIS FNAC RELAIS FNAC",
  "supplierid": 117,
  "type": 1,
  "parentid": null,
  "companyid": null,
  "status": 2,
  "compid": 1,
  "main_contactid": null,
  "commercial_contactid": null,
  "support_contactid": null,
  "ordering_contactid": null,
  "invoicing_contactid": null,
  "dunning_contactid": null,
  "reference": "",
  "external_reference": null,
  "title": null,
  "keyname": "relais-fnac-relais-fnac-49100",
  "name1": "RELAIS FNAC",
  "name2": "RELAIS FNAC",
  "name3": null,
  "name4": null,
  "email": "",
  "phone": null,
  "phone2": null,
  "fax": null,
  "communication_language": "fr",
  "zipcode": "49100",
  "city": "Angers",
  "country": "FR",
  "lat": "47.4768374",
  "lng": "-0.5561260",
  "areaid": 2289,
  "area_level": 8,
  "area_lvl1": 4,
  "area_lvl2": 21,
  "area_lvl3": 681,
  "area_lvl4": 744,
  "area_lvl5": 759,
  "area_lvl6": 897,
  "area_lvl7": 2233,
  "industry": null,
  "website": "",
  "picture": null,
  "assignment_type": 1,
  "assignment_targets": "[{\"eid\":101,\"id\":43,\"r\":1,\"d\":1}]",
  "owner_entityid": 101,
  "owner_objectid": 43,
  "timezone": null,
  "working_hours": null,
  "day_duration_in_hours": null,
  "holidays_country": null,
  "legal_form": "Société en nom collectif",
  "capital": "",
  "identification_number": "38803705300013",
  "trade_reg_number": "",
  "trade_reg_location": "",
  "vat_reg_number": "FR9388037053",
  "cnk_certificate_reference": null,
  "accountid": null,
  "account_number": null,
  "payment_mode": 3,
  "payment_conditionid": null,
  "expense_accounts": null,
  "expense_accountid": null,
  "costcenterid": null,
  "costcenters": null,
  "profitcenterid": null,
  "profitcenters": null,
  "vat_rates": null,
  "vatid": null,
  "currency": "EUR",
  "bank_account_owner": "",
  "bank_name": "",
  "bank_account_number": "",
  "swift": "",
  "iban": null,
  "first_contact_on": null,
  "last_contact_date": null,
  "last_activityid": 1471420,
  "last_email_sent_on": null,
  "last_email_received_on": null,
  "last_phone_call_on": null,
  "last_phone_successful_call_on": null,
  "last_meeting_on": "2025-01-23 16:45:00",
  "last_meeting_minute_on": "2025-01-23 16:50:00",
  "last_note_on": "2025-01-23 16:48:20",
  "last_action_on": "2025-01-23 16:50:00",
  "last_action_by_userid": 46,
  "taskid": null,
  "nb_of_open_tasks": null,
  "nb_of_tasks": null,
  "first_invoice_date": null,
  "last_invoice_date": null,
  "ocr_scan_modelid": null,
  "date_format": null,
  "number_format": null,
  "rate_format": null,
  "payment_notes": "",
  "tags": null,
  "comments": null,
  "active": 1,
  "nb_of_contacts": 0,
  "indexing_status": 0,
  "loekz": 0,
  "cdate": "2024-11-04 09:14:14",
  "cname": 46,
  "udate": "2025-01-23 16:50:22",
  "uname": 46,
  "versi": 4,
  "owner_label": "Céline C",
  "updateLink": "?route=suppliers/main&supplierid=117"
}

Demande d'Achat

Overview

Attributes

requestid int
ID Système

reference string
Référence

external_reference string
Réf. Externe

requester string
Demandeur

status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/333/values/

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/351/values/

date date
Date

last_activityid int (Liste déroulante : Activité)
Dernière action

ENDPOINTS

Liste des demandes d'achat

REQUEST

GET /purchaseRequests

RESPONSE

200 OK

Créer une nouvelle demande d'achat

REQUEST

POST /purchaseRequests

RESPONSE

200 OK

Récupérer une demande d'achat

Path params

Requestid (int)
Identifiant d'une demande d'achat

REQUEST

GET /purchaseRequests/{requestid}

RESPONSE

200 OK

Commande d'Achat

Overview

Attributes

poid int
ID Système

uid string
Unique ID

compid int (Liste déroulante : Société)
Société

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/361/values/

reference string
Référence

external_reference string
Réf. Externe

supplierid int (Liste déroulante : Fournisseur)
Fournisseur

grouping_key string
Clé de regroupement

contactid int (Liste déroulante : Contact)
Contact

customerid int (Liste déroulante : Compte)
Compte

main_contact_id int (Liste déroulante : Collaborateur)
Responsable

invoicing_contact_id string
Contact Facturation

requisitionner_entityid int (Liste déroulante : Entité)
Demandeur (Entity)
Endpoint de récupération des valeurs: /application/entities/2/values/

requisitionner_objectid int (Liste déroulante : Collaborateur)
Demandeur

taskid int (Liste déroulante : Tâche)
Dernière Tâche
Endpoint de récupération des valeurs: /application/entities/60/values/

requester_entityid int (Liste déroulante : Entité)
Demandeur de la validation (Entity)
Endpoint de récupération des valeurs: /application/entities/2/values/

requester_objectid int (Liste déroulante : Collaborateur)
Demandeur de la validation

assign_to_entityid string
Assigné à (Id Entité)

assign_to_objectid int (Liste déroulante : Collaborateur)
Assigné à

validator_entityid int (Liste déroulante : Entité)
Valideur (Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

validator_objectid int (Liste déroulante : Collaborateur)
Valideur

projectid int (Liste déroulante : Projet)
Projet

jobid int (Liste déroulante : Mission)
Mission

center_code string
Centre N°

status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/333/values/

date date
Date

reception_status int
Statut Réception

period_start date
Période (début)

reception_duedate datetime
Date de réception

period_end date
Période (Fin)

reception_estimate_duedate date
Date de réception prévue

payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/

payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/

item_gross_total double
Total Poste HT

item_grand_total double
Total Poste TTC

discount double
Remise

discount_type int
Type de Remise

discount_rate string
Remise (%)

discount_amount double
Remise (Montant)

vat_rate_1 string
Taux TVA (1)

vat_rate_1_amount double
Montant TVA (1)

vat_rate_2 string
Taux TVA (2)

vat_rate_2_amount double
Montant TVA (2)

vat_rate_3 string
Taux TVA (3)

vat_rate_3_amount double
Montant TVA (3)

gross_total double
Total HT

vat_rate string
Taux de TVA

taxes_total double
Total TVA

discount_total double
Total Remise

grand_total double
Total TTC

total_invoiced double
Total Facturé

total_paid double
Total Payé

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

has_documents boolean
Avec Pièces jointes

gross_total_received double
Montant Total réceptionné (HT)

billing_plan_type int
Type d'échéancier

grand_total_received double
Montant Total réceptionné

total_quantity float
Qté total commandée

billing_plan_frequency int
Période échéancier

total_received float
Qté total réceptionnée

total_to_be_received float
Qté restant à receptionner

billing_plan_start_on date
Echéancier début

last_activityid int (Liste déroulante : Activité)
Dernière action

billing_plan_end_on date
Echéancier fin

billing_plan_steps int
Nb. d'échéances

billing_day int
Jour de facturation

total_invoiced_quantity float
Qté total facturée

custom_text_1 longtext
Introduction

shipto_name1 string
Réceptionnaire - Nom 1

payment_date date
Date de paiement

shipto_name2 string
Réceptionnaire - Nom 2

shipto_street string
Réceptionnaire - Adresse

shipto_zipcode string
Réceptionnaire - Code Postal

shipto_city string
Réceptionnaire - Ville

shipto_state string
Réceptionnaire - Etat

shipto_country int (Liste déroulante : Pays)
Réceptionnaire - Pays
Endpoint de récupération des valeurs: /application/entities/13/values/

shipto_lat float
Réceptionnaire - Latitude

shipto_lng float
Réceptionnaire - Longitude

shipto_email1 string (CHAR255)
Réceptionnaire - Email

shipto_phone1 string (CHAR35)
Réceptionnaire - Téléphone 1

shipto_phone2 string (CHAR35)
Réceptionnaire - Téléphone 2

shipto_fax1 string (CHAR35)
Réceptionnaire - Fax 1

cdate datetime
Créé le

cname int (Liste déroulante : Utilisateur)
Créé par

udate datetime
MàJ le

uname int (Liste déroulante : Utilisateur)
MàJ par

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

ENDPOINTS

Liste des commandes d'achat

REQUEST

GET /purchaseOrders

RESPONSE

200 OK

Créer une nouvelle commande d'achat

REQUEST

POST /purchaseOrders

RESPONSE

200 OK

Récupérer une commande d'achat

Path params

Orderid (int)
Identifiant d'une commande d'achat

REQUEST

GET /purchaseOrders/{orderid}

RESPONSE

200 OK

Ligne de commande

Overview

Attributes

itemid int
ID Système

poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat

date date
Date

reference string
Référence

material_supplier_reference string
Code Article (Fournisseur)

requestid int (Liste déroulante : Demande d'Achat)
Demande d'Achat

request_itemid int (Liste déroulante : Poste)
Poste
Endpoint de récupération des valeurs: /application/entities/354/values/

catalogid int (Liste déroulante : Catalogue)
Catalogue

categoryid int (Liste déroulante : Catégorie)
Catégorie
Endpoint de récupération des valeurs: /application/entities/518/values/

materialid int (Liste déroulante : Produit)
Produit

projectid int (Liste déroulante : Projet)
Projet

serial_numbers string (TEXT)
N° de série

activityid int (Liste déroulante : Activité)
Activité

project_locked boolean
Projet Bloqué

label string
Libellé

ts_enable boolean
Imputable sur Feuille de temps

quantity float
Qté.

assign_to_name longtext (multiple)
Assigné à

quantity_invoiced float
Qté. facturée

unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/

assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

assign_to_objectid string
Assigné à (Id)

period_same_as_header boolean
Celle du document

period_start date
Période (début)

period_end date
Période (Fin)

period_quantity float
Période (Qté)

period_quantity_invoiced float
Période (Qté Facturée)

period_unit int
Période (Unité)

price double
Prix

vat_rate string
Taux de TVA

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

base_amount double
Montant de base

discount_type int
Type de Remise

discount double
Remise

discount_rate string
Remise (%)

discount_amount double
Remise (Montant)

gross_amount double
Montant HT

tax_amount double
Montant TVA

net_amount double
Montant TTC

amount_invoiced double
Montant facturé

comments longtext
Commentaires

accountid int (Liste déroulante : Compte Comptable)
Compte Comptable
Endpoint de récupération des valeurs: /accounts

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

ENDPOINTS

Liste des lignes de commande

REQUEST

GET /purchaseOrderItems

RESPONSE

200 OK

Créer une nouvelle ligne de commande

REQUEST

POST /purchaseOrderItems

RESPONSE

200 OK

Récupérer une ligne de commande

Path params

Itemid (int)
Identifiant d'une ligne de commande

REQUEST

GET /purchaseOrderItems/{itemid}

RESPONSE

200 OK

Facture d'achat

Overview

Attributes

piid int
ID Système

uid string
Unique ID

compid int (Liste déroulante : Société)
Société

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/371/values/

requestid int (Liste déroulante : Demande d'Achat)
Demande d'Achat

poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat

scanid int (Liste déroulante : Scan)
Scan
Endpoint de récupération des valeurs: /application/entities/1700/values/

jobid int (Liste déroulante : Mission)
Mission

projectid int (Liste déroulante : Projet)
Projet

reference string
Référence

label string
Libellé

external_reference string
Réf. Externe

supplierid int (Liste déroulante : Fournisseur)
Fournisseur

contactid int (Liste déroulante : Contact)
Contact

order_external_reference string
Commande Réf. Externe

main_contact_id int (Liste déroulante : Contact)
Contact Principal

assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

invoicing_contact_id int (Liste déroulante : Contact)
Contact Facturation

deadlineid int (Liste déroulante : Echéance)
Echéance
Endpoint de récupération des valeurs: /application/entities/366/values/

assign_to_name longtext (multiple)
Assigné à

assign_to_objectid string
Assigné à (Id)

employeeid int (Liste déroulante : Collaborateur)
Assigné à

project_locked boolean
Projet Bloqué

status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/333/values/

date date
Date

duedate date
Date d'échéance

period_start date
Période (début)

period_end date
Période (Fin)

payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/

payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/

item_gross_total double
Total Poste HT

item_grand_total double
Total Poste TTC

discount double
Remise

discount_type int
Type de Remise

discount_amount double
Remise (Montant)

discount_rate string
Remise (%)

vat_rate string
Taux de TVA

vatid int (Liste déroulante : Taux de TVA)
Taux TVA - Libellé
Endpoint de récupération des valeurs: /application/entities/1608/values/

vatid_1 int (Liste déroulante : Taux de TVA)
Taux TVA (1) - Libellé
Endpoint de récupération des valeurs: /application/entities/1608/values/

vat_rate_1 string
Taux TVA (1)

gross_total double
Total HT

vat_account_number string
Compte de TVA

taxes_total double
Total TVA

vat_rate_1_amount double
Montant TVA (1)

vatid_2 int (Liste déroulante : Taux de TVA)
Taux TVA (2) - Libellé
Endpoint de récupération des valeurs: /application/entities/1608/values/

discount_total double
Total Remise

vat_rate_1_amount_fixed double
Montant TVA corrigé (1)

vat_rate_2 string
Taux TVA (2)

grand_total double
Total TTC

paid_total double
Total Payé

vat_rate_2_amount double
Montant TVA (2)

vatid_3 int (Liste déroulante : Taux de TVA)
Taux TVA (3) - Libellé
Endpoint de récupération des valeurs: /application/entities/1608/values/

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

vat_rate_3 string
Taux TVA (3)

custom_text_1 longtext
Introduction

vat_rate_2_amount_fixed double
Montant TVA corrigé (2)

gross_total_company_currency double
Total HT (en devise société)

templateid int (Liste déroulante : Template (PDF,DOCX))
Template (PDF,DOCX)
Endpoint de récupération des valeurs: /application/entities/36/values/

vat_rate_3_amount double
Montant TVA (3)

grand_total_company_currency double
Total TTC (en devise société)

messageid int (Liste déroulante : Message)
Message
Endpoint de récupération des valeurs: /application/entities/1091/values/

company_currency int (Liste déroulante : Devise)
Devise Société
Endpoint de récupération des valeurs: /application/entities/9/values/

first_mailing_date datetime
Premier courriel le

last_mailing_date datetime
Dernier courriel le

vat_rate_3_amount_fixed double
Montant TVA corrigé (3)

has_documents boolean
Avec Pièces jointes

workflow_status int (Liste déroulante : Statut pour validation)
Statut pour validation
Endpoint de récupération des valeurs: /application/entities/56/values/

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

workflow_date datetime
Date (Workflow)

workflow_instanceid int
IID Workflow

total_quantity float
Qté total facturée

workflow_reason string (TEXT)
Commentaire (Workflow)

cdate datetime
Créé le

cname int (Liste déroulante : Utilisateur)
Créé par

last_activityid int (Liste déroulante : Activité)
Dernière action

udate datetime
MàJ le

uname int (Liste déroulante : Utilisateur)
MàJ par

remaining_total double
Reste à régler

payment_date datetime
Date de paiement

taxes_total_company_currency double
Total TVA (en devise société)

advance_total double
Total acompte

cycleid int (Liste déroulante : Cycle de Paiement)
Cycle de Paiement
Endpoint de récupération des valeurs: /paymentCycles

cycle_total double
Total Cycle

payments_total double
Total des paiements

dispatched_total double
Total réparti

rate_of_dispatch string
Taux de répartition

accounting_status_udate datetime
Comptabilisation (Date)

paid_total_company_currency double
Total Payé en devise société

accounting_reference string
N° de la pièce comptable

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

accounting_status int
Comptabilisation (Status)

accounting_docid int (Liste déroulante : Pièce Comptable)
Pièce Comptable
Endpoint de récupération des valeurs: /application/entities/1605/values/

accountid int (Liste déroulante : Compte Comptable)
Compte Comptable
Endpoint de récupération des valeurs: /accounts

ENDPOINTS

Liste des factures d'achat

REQUEST

GET /purchaseInvoices

RESPONSE

200 OK

Créer une nouvelle facture d'achat

REQUEST

POST /purchaseInvoices

RESPONSE

200 OK

Récupérer une facture d'achat

Path params

Invoiceid (int)
Identifiant d'une facture d'achat

REQUEST

GET /purchaseInvoices/{invoiceid}

RESPONSE

200 OK

Ligne de Facture

Overview

Attributes

itemid int
ID Système

piid int (Liste déroulante : Facture d'achat)
Facture d'achat

position int
Position

type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/361/values/

account string
N° compte

reference string
Référence

accountid int (Liste déroulante : Compte Comptable)
Compte Comptable
Endpoint de récupération des valeurs: /accounts

requestid int (Liste déroulante : Demande d'Achat)
Demande d'Achat

poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat

po_itemid int (Liste déroulante : Ligne de commande)
Ligne de commande

ts_enable boolean
Imputable sur Feuille de temps

catalogid int (Liste déroulante : Catalogue)
Catalogue

categoryid int (Liste déroulante : Catégorie)
Catégorie
Endpoint de récupération des valeurs: /application/entities/518/values/

materialid int (Liste déroulante : Produit)
Produit

projectid int (Liste déroulante : Projet)
Projet

activityid int (Liste déroulante : Activité)
Activité

project_locked boolean
Projet Bloqué

ticketid int (Liste déroulante : Ticket)
Ticket

label string
Libellé

sub_label string
Sous Libellé

unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/

assign_to_name longtext (multiple)
Assigné à

quantity float
Qté.

assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/

assign_to_objectid string
Assigné à (Id)

period_same_as_header boolean
Celle du document

period_quantity float
Période (Qté)

period_start date
Période (début)

period_end date
Période (Fin)

price double
Prix

discount double
Remise

discount_type int
Type de Remise

discount_amount double
Remise (Montant)

discount_rate string
Remise (%)

currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/

base_amount double
Montant de base

gross_amount double
Montant HT

vat_rate string
Taux de TVA

tax_amount double
Montant TVA

net_amount double
Montant TTC

costcenterid int (Liste déroulante : Centre de coût)
Centre de coût
Endpoint de récupération des valeurs: /application/entities/1620/values/

workflow_status int (Liste déroulante : Statut pour validation)
Statut pour validation
Endpoint de récupération des valeurs: /application/entities/56/values/

profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/

workflow_instanceid int (Liste déroulante : Workflow - Instance)
Workflow - Instance
Endpoint de récupération des valeurs: /application/entities/54/values/

workflow_date datetime
Date (Workflow)

workflow_reason string (TEXT)
Commentaire (Workflow)

comments longtext
Commentaires

ENDPOINTS

Liste des lignes de facture

REQUEST

GET /purchaseInvoiceItems

RESPONSE

200 OK

Créer un nouveau ligne de facture

REQUEST

POST /purchaseInvoiceItems

RESPONSE

200 OK

Récupérer un ligne de facture

Path params

Itemid (int)
Identifiant d'un ligne de facture

REQUEST

GET /purchaseInvoiceItems/{itemid}

RESPONSE

200 OK