VENTES
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/
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 productionhttps://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.
Produit
Overview
Attributes
materialid int
ID Système
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/502/values/
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/501/values/
reference string
Code
ean13 string
Code EAN
externalid string
Réf. Externe
upc string
Code
old_reference string
Ancien Code
hierarchy string
Hiérarchie
availability_delay float
Délai de livraison (Jour)
setid int (Liste déroulante : Groupe de Caracteristique)
Groupe de Caracteristique
Endpoint de récupération des valeurs: /application/entities/511/values/
Liste des produits
REQUEST
GET /materials
RESPONSE
200 OK
{
"queryUid": "902651e81731d7502f9b93ab9fa8cd4a",
"offset": 0,
"limit": 2,
"page": 1,
"pages": 1,
"total": 2,
"data": [
{
"id": 2,
"materialid": 2,
"status": 4,
"type": 3,
"is_bom": 0,
"reference": "FORM",
"supplierid": null,
"unit": 2,
"rate": null,
"ean13": null,
"externalid": null,
"extern_gid": null,
"brandid": null,
"setid": null,
"upc": null,
"old_reference": null,
"has_images": 0,
"hierarchy": null,
"new_from_date": null,
"new_to_date": null,
"availability_delay": null,
"loekz": 0,
"cdate": "2024-12-12 11:19:40",
"cname": 2,
"udate": "2024-12-12 11:19:40",
"uname": 2,
"versi": 1,
"filename": null,
"location": null
},
{
"id": 1,
"materialid": 1,
"status": 4,
"type": 3,
"is_bom": 0,
"reference": "PREST",
"supplierid": null,
"unit": 98,
"rate": null,
"ean13": null,
"externalid": null,
"extern_gid": null,
"brandid": null,
"setid": null,
"upc": null,
"old_reference": null,
"has_images": 0,
"hierarchy": null,
"new_from_date": null,
"new_to_date": null,
"availability_delay": null,
"loekz": 0,
"cdate": "2024-12-12 11:13:11",
"cname": 2,
"udate": "2024-12-12 11:13:11",
"uname": 2,
"versi": 1,
"filename": null,
"location": null
}
]
}
Créer un nouveau produit
REQUEST
POST /materials
{
"type" : 3,
"status": 4,
"reference": "PRODCOM"
}
RESPONSE
200 OK
{
"success": "Produit <b>PRODCOM - </b> a été ajouté",
"object": {
"id": "42",
"label": "PRODCOM - ",
"materialid": "42",
"status": 4,
"type": 3,
"is_bom": 0,
"reference": "PRODCOM",
"supplierid": null,
"unit": null,
"rate": null,
"ean13": null,
"externalid": null,
"extern_gid": null,
"brandid": null,
"setid": null,
"upc": null,
"old_reference": null,
"has_images": 0,
"hierarchy": null,
"new_from_date": null,
"new_to_date": null,
"availability_delay": null,
"loekz": 0,
"cdate": "2025-12-05 17:28:35",
"cname": 55,
"udate": "2025-12-05 17:28:35",
"uname": 55,
"versi": 1,
"updateLink": "?route=materials/main&materialid=42"
}
}
Récupérer un produit
Path params
Materialid (int)
Identifiant d'un produit
REQUEST
GET /materials/{materialid}
RESPONSE
200 OK
{
"id": 1,
"label": "PREST - Prestation de Recrutement",
"materialid": 1,
"status": 4,
"type": 3,
"is_bom": 0,
"reference": "PREST",
"supplierid": null,
"unit": 98,
"rate": null,
"ean13": null,
"externalid": null,
"extern_gid": null,
"brandid": null,
"setid": null,
"upc": null,
"old_reference": null,
"has_images": 0,
"hierarchy": null,
"new_from_date": null,
"new_to_date": null,
"availability_delay": null,
"loekz": 0,
"cdate": "2024-12-12 11:13:11",
"cname": 2,
"udate": "2024-12-12 11:13:11",
"uname": 2,
"versi": 1,
"updateLink": "?route=materials/main&materialid=1"
}
Catalogue
Overview
Attributes
catalogid int
ID Système
reference string
Référence
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/516/values/
label string
Libellé
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/517/values/
alias string
Alias
external boolean
Externe
period_left date
Début le
period_right date
Fin le
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
description string (TEXT)
Description
Liste des catalogues
REQUEST
GET /catalogs
RESPONSE
200 OK
{
"queryUid": "ce603ae6b5cd3c7feb4f05f694f09987",
"offset": 0,
"limit": 1,
"page": 1,
"pages": 1,
"total": 1,
"data": [
{
"id": 2,
"alias": null,
"description": "<br>",
"label": "Catalogue 2025",
"catalogid": 2,
"uid": "2-1764952424cd51b9aeeeb303cef36700f54326df27697",
"reference": "CAT25",
"type": "1",
"status": 1,
"language": "en",
"external": 0,
"period_left": "2025-12-05",
"period_right": null,
"currency": "EUR",
"active": 1,
"loekz": 0,
"cdate": "2025-12-05 17:33:44",
"cname": 54,
"udate": "2025-12-05 17:34:59",
"uname": 54,
"versi": 4
}
]
}
Créer un nouveau catalogue
REQUEST
POST /catalogs
{
"label" : "Catalogue 2026",
"reference" : "CAT26",
"type" : 1,
"status" : 3,
"external": 0,
"period_left" : "2025-12-05"
}
RESPONSE
200 OK
{
"success": "Catalogue <b>Catalogue 2026</b> a été ajouté",
"object": {
"id": "3",
"label": "Catalogue 2026",
"catalogid": "3",
"uid": "2-1764953083b590341c2036a7f0a17b42f3c51a027f69d",
"reference": "CAT26",
"type": 1,
"status": 3,
"language": "en",
"alias": null,
"external": 0,
"period_left": "2025-12-05",
"period_right": null,
"currency": null,
"description": null,
"active": 1,
"loekz": 0,
"cdate": "2025-12-05 17:44:43",
"cname": 55,
"udate": "2025-12-05 17:44:43",
"uname": 55,
"versi": 1,
"labelInOriginalLanguage": "Catalogue 2026",
"alias__orginal": null,
"description__orginal": null,
"updateLink": "?route=materials/catalogs/update&catalogid=3"
}
}
Récupérer un catalogue
Path params
Catalogid (int)
Identifiant d'un catalogue
REQUEST
GET /catalogs/{catalogid}
RESPONSE
200 OK
{
"id": 2,
"label": "Catalogue 2025",
"catalogid": 2,
"uid": "2-1764952424cd51b9aeeeb303cef36700f54326df27697",
"reference": "CAT25",
"type": "1",
"status": 1,
"language": "en",
"alias": null,
"external": 0,
"period_left": "2025-12-05",
"period_right": null,
"currency": "EUR",
"description": "<br>",
"active": 1,
"loekz": 0,
"cdate": "2025-12-05 17:33:44",
"cname": 54,
"udate": "2025-12-05 17:34:59",
"uname": 54,
"versi": 4,
"labelInOriginalLanguage": "Catalogue prestations 2025",
"alias__orginal": null,
"description__orginal": null,
"updateLink": "?route=materials/catalogs/update&catalogid=2"
}
Devis
Overview
Attributes
quotationid int
ID Système
uid string
Unique ID
compid int (Liste déroulante : Société)
Société
customerid int (Liste déroulante : Compte)
Compte
contactid int (Liste déroulante : Contact)
Contact
reference string
Référence
assign_to_contactid int (Liste déroulante : Contact)
Contact (assigné à)
opid int (Liste déroulante : Opportunité)
Opportunité
external_reference string
Réf. Externe
jobid int (Liste déroulante : Mission)
Mission
projectid int (Liste déroulante : Projet)
Projet
catalogid int (Liste déroulante : Catalogue)
Catalogue
date date
Date
end_date date
Valable jusqu'au
signature_date datetime
Date signature
duedate date
Date de livraison
employeeid int (Liste déroulante : Collaborateur)
Collaborateur
assign_to_name longtext (multiple)
Assigné à
req_delivery_date date
Livraison Souhaitée le
requester_entityid int (Liste déroulante : Entité)
Demandeur de la validation (Entity)
Endpoint de récupération des valeurs: /application/entities/2/values/
payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/
payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/
assign_to_entityid string
Assigné à (Id Entité)
requester_objectid int (Liste déroulante : Collaborateur)
Demandeur de la validation
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/1503/values/
assign_to_objectid string
Assigné à (Id)
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/1516/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)
gross_total double
Total HT
optional_gross_total double
Total En Option (HT)
vat_rate string
Taux de TVA
optional_grand_total double
Total En Option
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)
taxes_total double
Total TVA
grand_total double
Total TTC
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
custom_text_1 longtext
Introduction
custom_text_2 longtext
Conclusion
invoicing_modeid int (Liste déroulante : Modalité de facturation)
Modalité de facturation
Endpoint de récupération des valeurs: /application/entities/219/values/
main_contact_id int (Liste déroulante : Collaborateur)
Votre contact
support_contact_id int (Liste déroulante : Collaborateur)
Contact Support
invoicing_contact_id int (Liste déroulante : Collaborateur)
Contact Facturation
period_start date
Période (début)
period_end date
Période (Fin)
billing_plan_type int
Type d'échéancier
billing_plan_frequency int
Période échéancier
billing_plan_start_on date
Echéancier début
has_documents boolean
Avec Pièces jointes
billing_plan_end_on date
Echéancier fin
last_activityid int (Liste déroulante : Activité)
Dernière action
billing_plan_steps int
Nb. d'échéances
billing_day int
Jour de facturation
last_mailing_date datetime
Dernier courriel le
cname int (Liste déroulante : Utilisateur)
Créé par
cdate datetime
Créé le
udate datetime
MàJ le
uname int (Liste déroulante : Utilisateur)
MàJ par
profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
inline_files string
Pièces Jointes
nb_of_sub_items int
Nb. de sous poste
Liste des devis
REQUEST
GET /quotations
RESPONSE
200 OK
Créer un nouveau devis
REQUEST
POST /quotations
RESPONSE
200 OK
Récupérer un devis
Path params
Quotationid (int)
Identifiant d'un devis
REQUEST
GET /quotations/{quotationid}
RESPONSE
200 OK
Ligne de Devis
Overview
Attributes
itemid int
ID Système
type int (Liste déroulante : Type de poste)
Type de poste
Endpoint de récupération des valeurs: /application/entities/1513/values/
quotationid int (Liste déroulante : Devis)
Devis
status int (Liste déroulante : Statut pour validation)
Statut pour validation
Endpoint de récupération des valeurs: /application/entities/56/values/
optional boolean
En Option
position int
Position
materialid int (Liste déroulante : Produit)
Produit
projectid int (Liste déroulante : Projet)
Projet
activityid int (Liste déroulante : Activité)
Activité
label string
Libellé
reference string
Référence
external_reference string
Réf. Externe
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/
quantity float
Qté.
unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/
ts_enable boolean
Imputable sur Feuille de temps
assign_to_name longtext (multiple)
Assigné à
price double
Prix
assign_to_entityid string
Assigné à (Id Entité)
rate string
Taux
assign_to_objectid string
Assigné à (Id)
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
vat_rate string
Taux de TVA
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
duedate date
Date de livraison
req_delivery_date date
Livraison Souhaitée le
poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat
comments longtext
Commentaires
po_itemid int (Liste déroulante : Ligne de commande)
Poste cmd. d'achat
period_start date
Période (début)
period_end date
Période (Fin)
period_quantity float
Période (Qté)
period_unit int
Période (Unité)
period_quantity_invoiced float
Période (Qté Facturée)
Liste des lignes de devis
REQUEST
GET /quotationItems
RESPONSE
200 OK
Créer une nouvelle ligne de devis
REQUEST
POST /quotationItems
RESPONSE
200 OK
Récupérer une ligne de devis
Path params
Itemid (int)
Identifiant d'une ligne de devis
REQUEST
GET /quotationItems/{itemid}
RESPONSE
200 OK
Commande
Overview
Attributes
orderid int
ID Système
uid string
Unique ID
compid int (Liste déroulante : Société)
Société
customerid int (Liste déroulante : Compte)
Compte
contactid int (Liste déroulante : Contact)
Contact
employeeid int (Liste déroulante : Collaborateur)
Collaborateur
projectid int (Liste déroulante : Projet)
Projet
poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat
opid int (Liste déroulante : Opportunité)
Opportunité
quotationid int (Liste déroulante : Devis)
Devis
jobid int (Liste déroulante : Mission)
Mission
catalogid int (Liste déroulante : Catalogue)
Catalogue
reference int
N°
external_reference string
Réf. Externe
date date
Date
end_date date
Période (Fin)
signature_date datetime
Date signature
req_delivery_date date
Livraison Souhaitée le
requester_entityid int (Liste déroulante : Entité)
Demandeur de la validation (Entity)
Endpoint de récupération des valeurs: /application/entities/2/values/
duedate date
Date de livraison
assign_to_name longtext (multiple)
Assigné à
requester_objectid int (Liste déroulante : Collaborateur)
Demandeur de la validation
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/1503/values/
assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/
status_reason string (TEXT)
Commentaire (Statut)
assign_to_objectid string
Assigné à (Id)
cancellation_requested_on date
Résiliation demandée le
payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/
cancellation_date date
Date de résiliation
payment_conditionid int (Liste déroulante : Condition de paiement)
Condition de paiement
Endpoint de récupération des valeurs: /application/entities/1565/values/
type int (Liste déroulante : Type)
Type
Endpoint de récupération des valeurs: /application/entities/1521/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
grand_total double
Total TTC
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
custom_text_1 longtext
Introduction
invoicing_modeid int (Liste déroulante : Modalité de facturation)
Modalité de facturation
Endpoint de récupération des valeurs: /application/entities/219/values/
custom_text_2 longtext
Conclusion
support_contact_id int (Liste déroulante : Collaborateur)
Contact Support
invoicing_contact_id int (Liste déroulante : Collaborateur)
Contact Facturation
period_start date
Période (début)
period_end date
Période (Fin)
billing_plan_type int
Type d'échéancier
billing_plan_frequency int
Période échéancier
billing_plan_start_on date
Echéancier début
billing_plan_end_on date
Echéancier fin
billing_plan_steps int
Nb. d'échéances
billing_day int
Jour de facturation
has_documents boolean
Avec Pièces jointes
main_contact_id int (Liste déroulante : Collaborateur)
Votre contact
last_activityid int (Liste déroulante : Activité)
Dernière action
invoiceid int (Liste déroulante : Facture)
Première facture
total_invoiced double
Total Facturé
cdate datetime
Créé le
cname int (Liste déroulante : Utilisateur)
Créé par
uname int (Liste déroulante : Utilisateur)
MàJ par
still_to_invoice double
Reste à facturer
udate datetime
MàJ le
inline_files string
Pièces Jointes
candidateid int (Liste déroulante : Candidat)
Candidat
ENDPOINTS
Liste des commandes
REQUEST
GET /orders
RESPONSE
200 OK
Créer une nouvelle commande
REQUEST
POST /orders
RESPONSE
200 OK
Récupérer une commande
Path params
Orderid (int)
Identifiant d'une commande
REQUEST
GET /orders/{orderid}
RESPONSE
200 OK
Ligne de Commande/Contrat
Overview
Attributes
itemid int
ID Système
type int (Liste déroulante : Type de poste)
Type de poste
Endpoint de récupération des valeurs: /application/entities/1513/values/
orderid int (Liste déroulante : Commande)
Commande
entityid int (Liste déroulante : Entité)
Entité
Endpoint de récupération des valeurs: /application/entities/2/values/
position int
Position
objectid int
Id Objet
materialid int (Liste déroulante : Produit)
Produit
projectid int (Liste déroulante : Projet)
Projet
activityid int (Liste déroulante : Activité)
Activité
label string
Libellé
reference string
Référence
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/
assign_to_name longtext (multiple)
Assigné à
quantity float
Qté.
assign_to_entityid string
Assigné à (Id Entité)
unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/
assign_to_objectid string
Assigné à (Id)
rate string
Taux
price double
Prix
assign_to_employeeid int (Liste déroulante : Collaborateur)
Collaborateur (assigné à)
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
duedate date
Date de livraison
req_delivery_date date
Livraison Souhaitée le
poid int (Liste déroulante : Commande d'Achat)
Commande d'Achat
po_itemid int (Liste déroulante : Ligne de commande)
Poste cmd. d'achat
quotationid int (Liste déroulante : Devis)
Devis
quotation_itemid int (Liste déroulante : Ligne de Devis)
Poste Devis
comments longtext
Commentaires
amount_invoiced double
Montant facturé
quantity_invoiced float
Qté. facturée
period_start date
Période (début)
period_end date
Période (Fin)
period_unit int
Période (Unité)
period_quantity float
Période (Qté)
period_quantity_invoiced float
Période (Qté Facturée)
ts_enable boolean
Imputable sur Feuille de temps
profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
commissionable_percentage string
Taux de commissionnement
Liste des lignes de commande/contrat
REQUEST
GET /orderItems
RESPONSE
200 OK
Créer une nouvelle ligne de commande/contrat
REQUEST
POST /orderItems
RESPONSE
200 OK
Récupérer une ligne de commande/contrat
Path params
Itemid (int)
Identifiant d'une ligne de commande/contrat
REQUEST
GET /orderItems/{itemid}
RESPONSE
200 OK
Facture
Overview
Attributes
invoiceid 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/1541/values/
reference string
Référence
status int (Liste déroulante : Statut)
Statut
Endpoint de récupération des valeurs: /application/entities/1503/values/
customerid int (Liste déroulante : Compte)
Compte
contactid int (Liste déroulante : Contact)
Contact
quotationid int (Liste déroulante : Devis)
Devis
date date
Date
duedate date
Date d'échéance
orderid int (Liste déroulante : Commande)
Commande
employeeid int (Liste déroulante : Collaborateur)
Collaborateur
external_reference string
Réf. Externe
period_start date
Période (début)
assign_to_name longtext (multiple)
Assigné à
requester_entityid int (Liste déroulante : Entité)
Demandeur de la validation (Entity)
Endpoint de récupération des valeurs: /application/entities/2/values/
period_end date
Période (Fin)
assign_to_entityid string
Assigné à (Id Entité)
requester_objectid int (Liste déroulante : Collaborateur)
Demandeur de la validation
payment_mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/
assign_to_objectid string
Assigné à (Id)
discount_total double
Total Remise
profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
assign_to_contactid string
Contact (assigné à)
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
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)
gross_total double
Total HT
taxes_total double
Total TVA
vat_rate_3_amount double
Montant TVA (3)
grand_total double
Total TTC
invoicing_modeid int (Liste déroulante : Modalité de facturation)
Modalité de facturation
Endpoint de récupération des valeurs: /application/entities/219/values/
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
custom_text_1 longtext
Introduction
paid_total double
Total Payé
custom_text_2 longtext
Conclusion
remaining_total double
Reste à régler
first_payment_date datetime
Date du 1er paiement
payment_date datetime
Date de paiement
main_contact_id int (Liste déroulante : Collaborateur)
Votre contact
tax_payment_date date
Date paiement TVA
support_contact_id int (Liste déroulante : Collaborateur)
Contact Support
jobid int (Liste déroulante : Mission)
Mission
invoicing_contact_id int (Liste déroulante : Collaborateur)
Contact Facturation
projectid int (Liste déroulante : Projet)
Projet
gross_total_company_currency double
Total HT (en devise société)
messageid int (Liste déroulante : Message)
Message
Endpoint de récupération des valeurs: /application/entities/1091/values/
taxes_total_company_currency double
Total TVA (en devise société)
first_mailing_date datetime
Premier courriel le
grand_total_company_currency double
Total TTC (en devise société)
last_activityid int (Liste déroulante : Activité)
Dernière action
last_mailing_date datetime
Dernier courriel le
project_reference string
Code Projet
paid_total_company_currency double
Total Payé en devise société
company_currency int (Liste déroulante : Devise)
Devise Société
Endpoint de récupération des valeurs: /application/entities/9/values/
nb_of_dunning int
Nb. de relances
deadlineid int (Liste déroulante : Echéance)
Echéance
Endpoint de récupération des valeurs: /application/entities/1526/values/
last_dunning_date datetime
Dernière relance le
inline_files string
Pièces Jointes
parentid int (Liste déroulante : Facture)
Avoir/Facture liée
parent_reference string
Avoir/Facture liée (référence)
accounting_docid int (Liste déroulante : Pièce Comptable)
Pièce Comptable
Endpoint de récupération des valeurs: /application/entities/1605/values/
accounting_status int
Comptabilisation (Status)
candidateid int (Liste déroulante : Candidat)
Candidat
accounting_status_udate datetime
Comptabilisation (Date)
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
Liste des factures
REQUEST
GET /invoices
RESPONSE
200 OK
Créer une nouvelle facture
REQUEST
POST /invoices
RESPONSE
200 OK
Récupérer une facture
Path params
Invoiceid (int)
Identifiant d'une facture
REQUEST
GET /invoices/{invoiceid}
RESPONSE
200 OK
Ligne de Facture/Avoir
Overview
Attributes
itemid int
ID Système
invoiceid int (Liste déroulante : Facture)
Facture
type int (Liste déroulante : Type de poste)
Type de poste
Endpoint de récupération des valeurs: /application/entities/1513/values/
position int
Position
reference string
Référence
quotationid int (Liste déroulante : Devis)
Devis
external_reference string
Réf. Externe
quotation_itemid int (Liste déroulante : Ligne de Devis)
Poste Devis
orderid int (Liste déroulante : Commande)
Commande
order_itemid int (Liste déroulante : Ligne de Commande/Contrat)
Poste de Cmd.
materialid int (Liste déroulante : Produit)
Produit
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/
projectid int (Liste déroulante : Projet)
Projet
activityid int (Liste déroulante : Activité)
Activité
ticketid int (Liste déroulante : Ticket)
Ticket
label string
Libellé
account string
N° compte
sub_label string
Sous Libellé
assign_to_name longtext (multiple)
Assigné à
assign_to_entityid int (Liste déroulante : Entité)
Assigné à (Id Entité)
Endpoint de récupération des valeurs: /application/entities/2/values/
unit int (Liste déroulante : Unité)
Unité
Endpoint de récupération des valeurs: /application/entities/1510/values/
assign_to_objectid string
Assigné à (Id)
quantity float
Qté.
period_start datetime
Période (début)
assign_to_employeeid int (Liste déroulante : Collaborateur)
Assigné à
locationid int (Liste déroulante : Agence)
Agence
period_end datetime
Période (Fin)
profitcenterid int (Liste déroulante : Centre de profit)
Centre de profit
Endpoint de récupération des valeurs: /application/entities/1625/values/
period_quantity float
Période (Qté)
analytic_account string
Compte analytique
price double
Prix
rate string
Taux
discount_type int
Type de Remise
discount double
Remise
discount_rate string
Remise (%)
discount_amount double
Remise (Montant)
activity_entityid int (Liste déroulante : Entité)
Entité de liaison
Endpoint de récupération des valeurs: /application/entities/2/values/
activity_objectid int
Objet de liaison
increase string
Majoration
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
sign int
Sign (Crédit/Débit)
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
comments longtext
Commentaires
deadlineid int (Liste déroulante : Echéance)
Echéance
Endpoint de récupération des valeurs: /application/entities/1846/values/
commissionable_percentage string
Taux de commissionnement
Liste des lignes de facture/avoir
REQUEST
GET /invoiceItems
RESPONSE
200 OK
Créer une nouvelle ligne de facture/avoir
REQUEST
POST /invoiceItems
RESPONSE
200 OK
Récupérer une ligne de facture/avoir
Path params
Itemid (int)
Identifiant d'une ligne de facture/avoir
REQUEST
GET /invoiceItems/{itemid}
RESPONSE
200 OK
Paiement
Overview
Attributes
paymentid int
ID Système
compid int (Liste déroulante : Société)
Société
date date
Date
reference string
Référence
supplierid int (Liste déroulante : Fournisseur)
Fournisseur
customerid int (Liste déroulante : Compte)
Compte
target_name string
Cible
transactionid int (Liste déroulante : Transaction)
Transaction
Endpoint de récupération des valeurs: /application/entities/1584/values/
orderid int (Liste déroulante : Commande)
Commande
invoiceid int (Liste déroulante : Facture)
Facture
piid int (Liste déroulante : Facture d'achat)
Facture d'achat
status int
Status (Paiement)
type int
Type
mode int (Liste déroulante : Mode de paiement)
Mode de paiement
Endpoint de récupération des valeurs: /application/entities/1566/values/
amount double
Montant
amount_dispatched double
Montant réparti
currency int (Liste déroulante : Devise)
Devise
Endpoint de récupération des valeurs: /application/entities/9/values/
external_reference string
Réf. Externe
comments longtext
Commentaires
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
Liste des paiements
REQUEST
GET /payments
RESPONSE
200 OK
Créer un nouveau paiement
REQUEST
POST /payments
RESPONSE
200 OK
Récupérer un paiement
Path params
Paymentid (int)
Identifiant d'un paiement
REQUEST
GET /payments/{paymentid}
RESPONSE
200 OK
Liste des paiements
REQUEST
GET /payments/paypal\/notifications/
RESPONSE
200 OK