CustomerDocuments : Visma.net Financials Documents clients
read only REST
- Catalogue :
VismaNet - Schéma :
CustomerDocument - Libellé : Documents clients
Obtient une plage de documents clients - ScreenId=AR301000 La taille de page demandée doit être inférieure ou égale à la taille de page maximale autorisée, renvoyée dans les métadonnées. Si la taille de page demandée est supérieure à la taille de page maximale autorisée, la requête sera limitée à la taille de page maximale. Journal des modifications : 2020-mai : ajout de la pagination forcée. Données pour document client
Permet uniquement de récupérer des données.
Résumé
Données pour document client
Source de l'API
- Point de terminaison :
/v1/customerdocument - Opération :
get /v1/customerdocument
Caractéristiques de performance
| Characteristic | Value |
|---|---|
| Latence moyenne d'accès (ms) | 155 |
| Nombre de lignes par minute en mode de balayage complet | 29,100 |
| Nombre de lignes de requêtes ponctuelles par minute | 387 |
Le résultat peut être mis en cache côté client.
Paramètres
| Name | Type de données | Required | Default | Documentation |
|---|---|---|---|---|
branch |
`` | Filtrer par succursale | ||
closed |
`` | La date de clôture de la période comptable. | ||
created |
| [ ] | | Cette valeur, `` Remarque : CreatedDateTime et CreatedDateTimeCondition sont mutuellement inclusifs. |
|||
created |
`` | Cette valeur représente la condition à appliquer lors de la récupération des enregistrements.Valeurs acceptées (sans les guillemets simples) : * '>' pour supérieur à * '<' pour inférieur à * '>=' pour supérieur ou égal à * '<=' pour inférieur ou égal à Remarque : CreatedDateTime et CreatedDateTimeCondition sont mutuellement inclusifs. | ||
customer |
`` | Filtrer par client | ||
customer |
`` | Partie supérieure > Référence externe > La référence externe utilisée dans AutoInvoice. | ||
document |
`` | Cette valeur indique la date du document.Utilisez-le pour récupérer tous les enregistrements dont la date du document est postérieure à cette date, jusqu'au futur.Format accepté : * yyyy- * yyyy- * yyyy- * yyyy- * yyyy- Remarque : DocumentDate et DocumentDateCondition sont mutuellement inclusifs. |
||
document |
`` | Cette valeur représente la condition à appliquer à la date du document lors de la récupération des enregistrements.Valeurs acceptées (sans les guillemets simples) : * '>' pour supérieur à * '<' pour inférieur à * '>=' pour supérieur ou égal à * '<=' pour inférieur ou égal à Remarque : DocumentDate et DocumentDateCondition sont mutuellement inclusifs. | ||
document |
`` | Date d'échéance du paiement du document, conformément aux conditions de crédit. | ||
document |
`` | Cette valeur représente la condition à appliquer à la date d'échéance lors de la récupération des enregistrements.Valeurs acceptées (sans les guillemets simples) : * '>' pour supérieur à * '<' pour inférieur à * '>=' pour supérieur ou égal à * '<=' pour inférieur ou égal à | ||
document |
`` | Ce champ est obsolète pour les points de terminaison de documents clients spécifiques.Ce champ n'est utilisable que depuis le point de terminaison des documents clients.(Valeurs : Facture, DebitNote, CreditNote, Paiement, VoidPayment, Acompte, Remboursement, FinCharge, SmallBalanceWo, SmallCreditWo, CashSale, CashReturn, Non défini, NoUpdate) | ||
dunning |
`` | Date et heure de la dernière émission d'une lettre de relance pour le document. | ||
dunning |
`` | Définit une heure/date comme antérieure (<), postérieure (>), antérieure ou égale (=<) OU postérieure ou égale (=>) pour filtrer sur une période. | ||
dunning |
`` | Le niveau de relance du document. | ||
expand |
`` | Vrai si vous souhaitez voir toutes les informations de relance relatives à ce document. | ||
expand |
`` | Vrai si vous souhaitez voir toutes les pièces jointes relatives à ce document. | ||
expand |
`` | |||
expand |
`` | Vrai si vous souhaitez voir toutes les informations concernant l'adresse de facturation de ce document. | ||
expand |
`` | Vrai si vous souhaitez voir tous les détails de TVA concernant ce document. | ||
external |
`` | Partie supérieure > Référence externe > La référence externe utilisée dans AutoInvoice. | ||
financial |
`` | La période comptable à laquelle les transactions enregistrées dans le document sont comptabilisées.Format AAAAMM. | ||
greater |
`` | Valeur supérieure à.L'élément qui est l'objet de ceci varie selon l'API. | ||
last |
| [ ] | | Cette valeur, `` Remarque : LastModifiedDateTime et LastModifiedDateTimeCondition sont mutuellement inclusifs. |
|||
last |
`` | Cette valeur représente la condition à appliquer lors de la récupération des enregistrements.Valeurs acceptées (sans les guillemets simples) : * '>' pour supérieur à * '<' pour inférieur à * '>=' pour supérieur ou égal à * '<=' pour inférieur ou égal à Remarque : LastModifiedDateTime et LastModifiedDateTimeCondition sont mutuellement inclusifs. | ||
payment |
`` | La partie supérieure > Réf. paiement > Le numéro de référence du document, généré automatiquement par le système conformément à la série de numérotation attribuée aux ventes comptant dans la fenêtre Préférences du grand livre clients.. | ||
project |
`` | Le projet auquel le document est associé. | ||
released |
`` | Paramètre indiquant si la facture a été validée ou non. | ||
status |
`` | Le statut du document.Utilisez la liste déroulante pour sélectionner le statut.(Valeurs : En attente, Équilibré, Annulé, Planifié, Ouvert, Clôturé, PendingPrint, PendingEmail, CreditHold, CcHold, Réservé) |
Colonnes de table
Les colonnes de la table CustomerDocuments sont présentées ci-dessous. Chaque colonne possède un type de données SQL. Une nouvelle valeur non nulle doit être fournie pour chaque colonne requise à tout moment lors de l'insertion et de la mise à jour.
| Name | Type de données | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
COMPANY_ |
varchar2 |
Code d'entreprise | writable | Code de partition, segmentant les données. | |
COMPANY_ |
varchar2 |
Nom de société | writable | Nom de la partition. | |
account_ |
char |
Compte actif | filtres sur la plateforme, modifiables, account. |
||
account_ |
varchar2 |
Description du compte | filtres sur la plateforme, modifiables, account. |
Nom de l'élément/description | |
account_ |
varchar2 |
Code externe du compte 1 | filtres sur la plateforme, modifiables, account. |
Classe de compte > L'identifiant de la classe de compte. | |
account_ |
varchar2 |
Code externe du compte 2 | filtres sur la plateforme, modifiables, account. |
Classe de compte > Le nom de la classe de compte. | |
account_ |
varchar2 |
Numéro de compte | filtres sur la plateforme, modifiables, account. |
Nombre d'éléments | |
account_ |
varchar2 |
Type de compte | filtres sur la plateforme, modifiables, account. |
Compte > Le numéro de compte. | |
amount |
double |
Amount | filtres sur la plateforme, modifiables, amount |
La partie supérieure > Montant > Le montant réglé par le document.La valeur apparaît pour les nouveaux documents si la case Valider les totaux du document à la saisie est cochée dans la fenêtre AR101000.Si la case n'est pas cochée, la valeur apparaît lorsque le statut du document est Ouvert. | |
amount |
double |
Montant en Devise | filtres sur la plateforme, modifiables, amount |
Calcul en arrière-plan vous donnant le montant dans votre devise par défaut.Ce champ est applicable si le montant est indiqué dans une autre devise que votre devise par défaut. | |
balance |
double |
Balance | filtres sur la plateforme, modifiables, balance |
Partie supérieure > Solde > Pour un document de compte client ouvert, le solde après déduction de l'escompte éventuel.Pour un document utilisé dans le processus d'imputation, il s'agit du solde après application des paiements. | |
balance |
double |
Solde en devises | filtres sur la plateforme, modifiables, balance |
Calcul en arrière-plan donnant le solde dans votre devise par défaut.Ce champ est applicable si le montant est indiqué dans une autre devise que votre devise par défaut. | |
branch |
varchar2 |
Nom de la branche | filtres sur la plateforme, modifiables, branch |
Cliquez sur la loupe. > Le nom. | |
branch |
varchar2 |
Numéro d'agence | filtres sur la plateforme, modifiables, branch |
Cliquez sur la loupe. > L'identifiant. | |
branch_ |
varchar2 |
Nom de la branche | filtres sur la plateforme, modifiables, branch. |
Cliquez sur la loupe. > Le nom. | |
branch_ |
varchar2 |
Numéro d'agence | filtres sur la plateforme, modifiables, branch. |
Cliquez sur la loupe. > L'identifiant. | |
cash |
varchar2 |
Compte de trésorerie | filtres sur la plateforme, modifiables, cash |
Onglet Détails financiers > Section Informations de paiement > Compte de trésorerie > Le compte de trésorerie associé au mode de paiement. | |
cash |
double |
Remise pour paiement comptant | filtres sur la plateforme, modifiables, cash |
La partie supérieure > Escompte > Le montant de l'escompte qui a été ou sera appliqué sur le document, calculé par le système selon les conditions de crédit spécifiées. | |
cash |
double |
Escompte pour paiement comptant en devises | filtres sur la plateforme, modifiables, cash |
Calcul en arrière-plan donnant l'escompte dans votre devise par défaut.Ce champ s'applique si le montant est exprimé dans une autre devise que votre devise par défaut. | |
closed |
varchar2 |
Période comptable clôturée | filtres sur la plateforme, modifiables, closed |
Format AAAAMM. | |
created |
datetime |
Created | filtres sur la plateforme, modifiables, created |
L'onglet Pièces jointes > Heure de création > La date de création de la pièce jointe. | |
currency |
varchar2 |
Code de devise | filtres sur la plateforme, modifiables, currency |
Partie supérieure > Devise > La devise du document.Par défaut, il s'agit de la devise par défaut du client, mais elle peut être modifiée si la case Autoriser le remplacement de devise est sélectionnée dans la fenêtre AR303000. | |
customer |
varchar2 |
Projet client | filtres sur la plateforme, modifiables, customer |
La partie supérieure > N° projet client > Le numéro de projet client utilisé dans AutoInvoice. | |
customer |
varchar2 |
Référence personnalisée | filtres sur la plateforme, modifiables, customer |
Partie supérieure > Référence externe > La référence externe utilisée dans AutoInvoice. | |
customer_ |
varchar2 |
Nom du client | filtres sur la plateforme, modifiables, customer. |
Cliquez sur la loupe. > Le nom. | |
customer_ |
varchar2 |
Numéro de client | filtres sur la plateforme, modifiables, customer. |
||
document |
datetime |
Date de document | filtres sur la plateforme, modifiables, document |
Partie supérieure > Date* > La date de création du document de compte client.Par défaut, pour un nouveau document, il s'agit de la date d'activité en cours, mais vous pouvez modifier la date. | |
document |
datetime |
Date limite de remise du document | filtres sur la plateforme, modifiables, document |
||
document |
varchar2 |
Type de document | filtres sur la plateforme, modifiables, document |
La partie supérieure > Type > Le type de document.Les types suivants sont disponibles : facture, note de débit, avoir, pénalité de retard, abandon de créance. | |
error |
varchar2 |
Message d'Erreur | filtres sur la plateforme, modifiables, error |
||
financial |
varchar2 |
Période Financière | filtres sur la plateforme, modifiables, financial |
La période comptable à laquelle les transactions enregistrées dans le document doivent être comptabilisées.Format AAAAMM. | |
invoice |
varchar2 |
Texte de facture | filtres sur la plateforme, modifiables, invoice |
Partie supérieure > Texte de facture > Toute description saisie par l'utilisateur du document de compte client. | |
last |
datetime |
Dernière modification | filtres sur la plateforme, modifiables, last |
Champ généré par le système pour la date/heure de la dernière modification du document. | |
location_ |
varchar2 |
Code pays de localisation | filtres sur la plateforme, modifiables, location. |
Location*. | |
location_ |
varchar2 |
ID d'emplacement | filtres sur la plateforme, modifiables, location. |
Cliquez sur la loupe > L'identifiant | |
location_ |
varchar2 |
Nom du Lieu | filtres sur la plateforme, modifiables, location. |
Cliquez sur la loupe > Le nom affiché | |
metadata_ |
int64 |
Taille maximale des métadonnées | filtres sur la plateforme, modifiables, metadata. |
||
metadata_ |
int64 |
Nombre total | filtres sur la plateforme, modifiables, metadata. |
||
note |
varchar2 |
Note | filtres sur la plateforme, modifiables, note |
Icône Notes en haut de la fenêtre > Fenêtre contextuelle permettant de saisir tout texte défini par l'utilisateur lié au document. | |
orig |
datetime |
Date de la facture d'origine | filtres sur la plateforme, modifiables, orig |
Partie supérieure > Date de facture d'origine > La date à partir de laquelle la date d'échéance et la date d'escompte sont calculées.Utilisé uniquement si le paramètre « Utiliser date facture d'origine » est actif dans les préférences AR.Par défaut, pour un nouveau document, il s'agit de la date d'activité en cours, mais vous pouvez modifier la date. | |
payment |
varchar2 |
Description des modes de paiement | filtres sur la plateforme, modifiables, payment |
Cliquez sur la loupe. > La description. | |
payment |
varchar2 |
Identifiant du mode de paiement | filtres sur la plateforme, modifiables, payment |
Cliquez sur la loupe. > L'identifiant. | |
post |
varchar2 |
Période comptable | filtres sur la plateforme, modifiables, post |
La partie supérieure > Période de comptabilisation > La période à laquelle le document doit être comptabilisé.Format AAAAMM. | |
project_ |
varchar2 |
Description du projet | filtres sur la plateforme, modifiables, project. |
Cliquez sur la loupe. > La description. | |
project_ |
varchar2 |
Identifiant du projet | filtres sur la plateforme, modifiables, project. |
Cliquez sur la loupe. > L'identifiant. | |
project_ |
int32 |
itgen_vnet_project_internalid | filtres sur la plateforme, modifiables, project. |
L'identifiant interne. | |
reference |
varchar2 |
Numéro de Référence | filtres sur la plateforme, modifiables, reference |
Partie supérieure > N° de réf. > Le numéro de référence du document du grand livre clients dans le système. | |
status |
varchar2 |
Status | filtres sur la plateforme, modifiables, status |
La partie supérieure > Statut > Le statut du document, qui peut être l'un des suivants : En attente, Équilibré, Annulé, Planifié, Ouvert, Clôturé, En attente d'impression, En attente d'e-mail. | |
subaccount_ |
char |
Sous-compte actif 2 | filtres sur la plateforme, modifiables, subaccount. |
Actif > Le statut de l'identifiant. | |
subaccount_ |
varchar2 |
Description du sous-compte | filtres sur la plateforme, modifiables, subaccount. |
Description > La description de l'identifiant. | |
subaccount_ |
varchar2 |
Message d'erreur lié au sous-compte | filtres sur la plateforme, modifiables, subaccount. |
||
subaccount_ |
datetime |
Dernière modification du sous-compte | filtres sur la plateforme, modifiables, subaccount. |
Informations générées par le système. | |
subaccount_ |
int64 |
Taille maximale des métadonnées d'un sous-compte | filtres sur la plateforme, modifiables, subaccount. |
||
subaccount_ |
int64 |
Nombre total de métadonnées des sous-comptes | filtres sur la plateforme, modifiables, subaccount. |
||
subaccount_ |
int32 |
Identifiant du sous-compte | filtres sur la plateforme, modifiables, subaccount. |
SubID > L'identifiant du sous-compte. | |
subaccount_ |
varchar2 |
Numéro de sous-compte | filtres sur la plateforme, modifiables, subaccount. |
Champ obligatoire : Sous-compte* > Le numéro du sous-compte.Format 9-XX. | |
subaccount_ |
blob |
itgen_vnet_subaccount_timestamp | filtres sur la plateforme, modifiables, subaccount. |
L'horodatage du sous-compte, utilisé pour le contrôle de concurrence. | |
vat |
double |
TVA totale | filtres sur la plateforme, modifiables, vat |
Partie supérieure > Total TVA > Le montant de TVA du document, tel que défini dans l'onglet Détails TVA. | |
vat |
double |
TVA totale en [devise] | filtres sur la plateforme, modifiables, vat |
Calcul en arrière-plan donnant le total de TVA dans votre devise par défaut.Ce champ est applicable si le montant est indiqué dans une autre devise que votre devise par défaut. |
Clés
| Key | Column | Se réfère à | Kind | Description |
|---|---|---|---|---|
Customer |
account_ |
Accounts. |
Key | |
Customer |
branch |
Branches. |
Key | |
Customer |
branch_ |
Branches. |
Key | |
Customer |
currency |
Currencies.id |
Key | |
Customer |
customer_ |
Customers. |
Key | |
Customer |
location_ |
Countries.id |
Key | |
Customer |
payment |
PaymentMethods. |
Key | |
Customer |
project_ |
Projects. |
Textual | Le projet, ou le code « aucun projet » lorsque le document n'est pas associé à un projet ; ce code n'a pas de ligne dans Projets. |
Notes de Version
Quels ont été les changements apportés à chaque version au niveau des tables, des colonnes, des attributs et des fonctionnalités du chauffeur :