Clients / Soldes, Mouvements, Dates
API Reference : clients
Description
Fonctions de calcul des soldes, mouvements et dates dernières factures et règlements
- Toutes ces fonctions renvoient une valeur unique.
- Tous les paramètres sont obligatoires mais seront ignorés s’ils sont affectés à la valeur
null.
Accès rapide
Solde d’un client
Cette fonction renvoie le solde d’un client.
Cette fonctions n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/solde() |
Solde du client |
Paramètres
Aucun paramètre pour cette fonction
Exemple
- Solde du client {id}.
/{datasetId}/clients('{id}')/solde()
Mouvement débit d’un client
Cette fonction renvoie le total débit d’un client.
Des paramètres permettent de filtrer sur un compte général, un journal et une période de dates.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/mvtDebit('{numCompte}','{numJournal}',{dateDebut},{dateFin}) |
Mouvement débit du client |
Paramètres
| Nom | Description | Exemple |
|---|---|---|
| numCompte | Numéro de compte général | ‘4110000’ |
| numJournal | Code du journal | ‘VTE’ |
| dateDebut | Date minimale | 2020-01-01 |
| dateFin | Date maximale | 2020-12-31 |
Exemples
- Total débit du client {id} pour les écritures du compte 4110000, du journal VTE entre le 1er janvier et le 31 octobre 2020.
/{datasetId}/clients('{id}')/mvtDebit(numCompte='4110000',numJournal='VTE',dateDebut=2020-01-01,dateFin=2020-10-31) - Total débit du client {id} pour toutes les écritures de l’exercice.
/{datasetId}/clients('{id}')/mvtDebit(numCompte=null,numJournal=null,dateDebut=null,dateFin=null)
Mouvement crédit d’un client
Cette fonction renvoie le total crédit d’un client.
Des paramètres permettent de filtrer sur un compte général, un journal et une période de dates.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/mvtCredit('{numCompte}','{numJournal}',{dateDebut},{dateFin}) |
Mouvement crédit du client |
Paramètres
| Nom | Description | Exemple |
|---|---|---|
| numCompte | Numéro de compte général | ‘4110000’ |
| numJournal | Code du journal | ‘VTE’ |
| dateDebut | Date minimale | 2020-01-01 |
| dateFin | Date maximale | 2020-12-31 |
Exemples
- Total crédit du client {id} pour les écritures du compte 4110000, du journal VTE entre le 1er janvier et le 31 octobre 2020.
/{datasetId}/clients('{id}')/mvtCredit(numCompte='4110000',numJournal='VTE',dateDebut=2020-01-01,dateFin=2020-10-31) - Total crédit du client {id} pour toutes les écritures de l’exercice.
/{datasetId}/clients('{id}')/mvtCredit(numCompte=null,numJournal=null,dateDebut=null,dateFin=null)
Solde mouvements d’un client
Cette fonction renvoie aussi le solde d’un client mais contrairement à la fonction solde(), cette fonction permet d’ajouter des filtres.
Des paramètres permettent de filtrer sur un compte général, un journal et une période de dates.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/mvtSolde('{numCompte}','{numJournal}',{dateDebut},{dateFin}) |
Solde des mouvements du client |
Paramètres
| Nom | Description | Exemple |
|---|---|---|
| numCompte | Numéro de compte général | ‘4110000’ |
| numJournal | Code du journal | ‘VTE’ |
| dateDebut | Date minimale | 2020-01-01 |
| dateFin | Date maximale | 2020-12-31 |
Exemples
- Solde du client {id} pour les écritures mouvementées du compte 4110000, du journal VTE entre le 1er janvier et le 31 octobre 2020.
/{datasetId}/clients('{id}')/mvtSolde(numCompte='4110000',numJournal='VTE',dateDebut=2020-01-01,dateFin=2020-10-31) - Solde du client {id} pour toutes les écritures de l’exercice.
/{datasetId}/clients('{id}')/mvtSolde(numCompte=null,numJournal=null,dateDebut=null,dateFin=null)
Solde échu à 1 mois d’un client
Cette fonction renvoie le solde échu à 1 mois d’un client (retards de paiement de moins de 30 jours par rapport à l’échéance).
Cette fonction n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/soldeEchu1() |
Solde échu à 1 mois du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Solde échu à 1 mois du client {id}.
/{datasetId}/clients('{id}'/)soldeEchu1()
Solde échu à 2 mois d’un client
Cette fonction renvoie le solde échu à 2 mois d’un client (retards de paiement de 30 à 60 jours par rapport à l’échéance).
Cette fonction n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/soldeEchu2() |
Solde échu à 2 mois du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Solde échu à 2 mois du client {id}.
/{datasetId}/clients('{id}'/)soldeEchu2()
Solde échu à 3 mois d’un client
Cette fonction renvoie le solde échu à 3 mois d’un client (retards de paiement de plus de 60 jours par rapport à l’échéance).
Cette fonction n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/soldeEchu3() |
Solde échu à 3 mois du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Solde échu à 3 mois du client {id}.
/{datasetId}/clients('{id}'/)soldeEchu3()
Solde échu d’un client
Cette fonction renvoie le solde échu d’un client (échéances échues).
Cette fonction n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/soldeEchu() |
Solde échu du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Solde échu du client {id}.
/{datasetId}/clients('{id}'/)soldeEchu()
Solde non échu d’un client
Cette fonction renvoie le solde non échu d’un client (échéances non encore échues).
Cette fonction n’a pas de paramètres.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/soldeNonEchu() |
Solde non échu du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Solde non échu du client {id}.
/{datasetId}/clients('{id}'/)soldeNonEchu()
Date dernière facture d’un client
Cette fonction renvoie la date de dernière facture d’un client (date de la dernière facture enregistrée sur un journal de vente).
Cette fonction n’a pas de paramètres.
Attention ! Si aucune facture n’est trouvée la valeur renvoyée sera 0001-01-01T00:00:00Z.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/derniereFacture() |
Date dernière facture du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Date de dernière facture du client {id}.
/{datasetId}/clients('{id}')/derniereFacture()
Date dernier règlement d’un client
Cette fonction renvoie la date de dernier règlement d’un client (date du dernier règlement enregistré sur un journal de trésorerie).
Cette fonction n’a pas de paramètres.
Attention ! Si aucun règlement n’est trouvé la valeur renvoyée sera 0001-01-01T00:00:00Z.
Route
| Verbe | Route | Description |
|---|---|---|
/{datasetId}/clients('{id}')/dernierReglement() |
Date dernier règlement du client |
Paramètres
Aucun paramètre pour cette fonction.
Exemples
- Date de dernier règlement du client {id}.
/{datasetId}/clients('{id}')/dernierReglement()