invantive documentation
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

CustomerContracts : Contrats clients Visma.net Financials

insert update REST

  • Catalogue : VismaNet
  • Schéma : CustomerContract
  • Clés primaires : contractId
  • Libellé : Contrats clients

Récupérer une plage de contrats clients ; un filtre doit être spécifié - ScreenId=CT301000

Permet de récupérer et de modifier des données à l'aide de insert et update.

Source de l'API

  • Point de terminaison : /v1/customerContract
  • Opération : get /v1/customerContract

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
attributes `` Attributs (informations supplémentaires) liés à l'entité.Exemples : {{base}}/customerContract?attributes={"AttributeID":"ValueID","AttributeID":"ValueID"} {{base}}/customerContract?attributes={"AttributeID":"ValueID1,ValueID2"}
contractTemplate ``
customer ``
expandAttributes ``
expandDetails ``
expandSummary ``
greaterThanValue ``
lastModifiedDateTime ``
lastModifiedDateTimeCondition ``
status `` Valeurs : Brouillon, InApproval, Actif, Expiré, Annulé, Terminé, InUpgrade, PendingActivation.

Colonnes de table

Les colonnes de la table CustomerContracts 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_CODE varchar2(30) Code d'entreprise writable Code de partition, segmentant les données.
COMPANY_NAME varchar2(240) Nom de société writable Nom de la partition.
balance double Balance filtres sur la plateforme, modifiables, balance La partie supérieure > Solde > Champ en lecture seule affichant la somme des soldes des factures ouvertes associées au contrat.
contractId varchar2 Référence du contrat filtres sur la plateforme, modifiables, contractId Champ obligatoire : partie supérieure > ID contrat* > L'identifiant unique d'un contrat.
contractTemplate_description varchar2 Description du modèle de contrat filtres sur la plateforme, modifiables, contractTemplate.description Cliquez sur la loupe. > La description.
contractTemplate_id varchar2 Référence du modèle de contrat filtres sur la plateforme, modifiables, contractTemplate.id Cliquez sur la loupe. > L'identifiant.
customer_name varchar2 Nom du client filtres sur la plateforme, modifiables, customer.name Cliquez sur la loupe. > Le nom.
customer_number varchar2 Numéro de client filtres sur la plateforme, modifiables, customer.number
description varchar2 Description filtres sur la plateforme, modifiables, description Champ obligatoire : partie supérieure > Description* > La description du contrat, qui inclut tout commentaire associé.
details_currentRecurring double itgen_vnet_details_currentrecurring filtres sur la plateforme, modifiables, details.currentRecurring
details_currentRenewal double itgen_vnet_details_currentrenewal filtres sur la plateforme, modifiables, details.currentRenewal
details_currentSetup double itgen_vnet_details_currentsetup filtres sur la plateforme, modifiables, details.currentSetup
details_effectiveFrom datetime itgen_vnet_details_effectivefrom filtres sur la plateforme, modifiables, details.effectiveFrom
details_pendingRecurring double itgen_vnet_details_pendingrecurring filtres sur la plateforme, modifiables, details.pendingRecurring
details_pendingRenewal double itgen_vnet_details_pendingrenewal filtres sur la plateforme, modifiables, details.pendingRenewal
details_pendingSetup double itgen_vnet_details_pendingsetup filtres sur la plateforme, modifiables, details.pendingSetup
details_promoCode_description varchar2 itgen_vnet_details_promocode_description filtres sur la plateforme, modifiables, details.promoCode.description Cliquez sur la loupe. > La description.
details_promoCode_id varchar2 itgen_vnet_details_promocode_id filtres sur la plateforme, modifiables, details.promoCode.id Cliquez sur la loupe. > L'identifiant.
details_totalPending double Total en attente filtres sur la plateforme, modifiables, details.totalPending
lastModifiedDateTime datetime Dernière modification filtres sur la plateforme, modifiables, lastModifiedDateTime Informations générées par le système
location_description varchar2 Description de la localisation filtres sur la plateforme, modifiables, location.description Cliquez sur la loupe. > La description.
location_id varchar2 ID d'emplacement filtres sur la plateforme, modifiables, location.id Cliquez sur la loupe. > L'identifiant.
status varchar2 Status filtres sur la plateforme, modifiables, status La partie supérieure > Statut > Le statut du contrat, qui est l'un des suivants : Brouillon, En attente d'activation, Actif, Expiré, Annulé, En attente de mise à jour.
summary_activationDate datetime Date d'activation filtres sur la plateforme, modifiables, summary.activationDate Section Paramètres du contrat > Date d'activation > La date à laquelle démarre la fourniture des services du contrat.
summary_caseCountItem_description varchar2 itgen_vnet_summary_casecountitem_description filtres sur la plateforme, modifiables, summary.caseCountItem.description Nom de l'élément/description
summary_caseCountItem_number varchar2 itgen_vnet_summary_casecountitem_number filtres sur la plateforme, modifiables, summary.caseCountItem.number Nombre d'éléments
summary_currency varchar2 Currency filtres sur la plateforme, modifiables, summary.currency Champ obligatoire : Section Paramètres du contrat > Devise* > La devise utilisée dans le contrat.
summary_expirationDate datetime Date d'Expiration filtres sur la plateforme, modifiables, summary.expirationDate Section Paramètres du contrat > Date d'expiration > La date à laquelle le contrat expire.
summary_gracePeriod int32 Délai de grâce filtres sur la plateforme, modifiables, summary.gracePeriod Section Paramètres du contrat > Période de grâce > Le nombre de jours après la date d'expiration pendant lesquels le contrat peut encore être renouvelé.
summary_invoiceAccount_name varchar2 itgen_vnet_summary_invoiceaccount_name filtres sur la plateforme, modifiables, summary.invoiceAccount.name Cliquez sur la loupe. > Le nom.
summary_invoiceAccount_number varchar2 itgen_vnet_summary_invoiceaccount_number filtres sur la plateforme, modifiables, summary.invoiceAccount.number
summary_invoiceLocation_description varchar2 itgen_vnet_summary_invoicelocation_description filtres sur la plateforme, modifiables, summary.invoiceLocation.description Cliquez sur la loupe. > La description.
summary_invoiceLocation_id varchar2 itgen_vnet_summary_invoicelocation_id filtres sur la plateforme, modifiables, summary.invoiceLocation.id Cliquez sur la loupe. > L'identifiant.
summary_invoiceTo varchar2 itgen_vnet_summary_invoiceto filtres sur la plateforme, modifiables, summary.invoiceTo Section Informations de facturation > Facturer à > Le paramètre qui définit le compte client à facturer pour un contrat.Les options suivantes sont disponibles : Compte parent, Compte client, Compte spécifique.
summary_invoicingPeriod varchar2 itgen_vnet_summary_invoicingperiod filtres sur la plateforme, modifiables, summary.invoicingPeriod Champ obligatoire : Section Calendrier de facturation > Période de facturation* > Le type de calendrier de facturation, qui peut être l'une des options suivantes : Hebdomadaire, Mensuel ; Trimestriel, Semestriel, Annuel, Sur demande, Basé sur des relevés.
summary_invoicingScheduleStartsOn datetime itgen_vnet_summary_invoicingschedulestartson filtres sur la plateforme, modifiables, summary.invoicingScheduleStartsOn Section Calendrier de facturation > La facturation commence le > Champ en lecture seule affichant la date de début de la première période de facturation.
summary_lastInvoicingDate datetime itgen_vnet_summary_lastinvoicingdate filtres sur la plateforme, modifiables, summary.lastInvoicingDate Section Calendrier de facturation > Date de dernière facturation > Champ en lecture seule indiquant la date à laquelle la facturation a été effectuée le plus récemment.
summary_massRenewal char itgen_vnet_summary_massrenewal filtres sur la plateforme, modifiables, summary.massRenewal Section Paramètres du contrat > Renouvellement en masse > Case à cocher indiquant le renouvellement de tous les contrats à la date d'expiration.
summary_nextInvoicingDate datetime itgen_vnet_summary_nextinvoicingdate filtres sur la plateforme, modifiables, summary.nextInvoicingDate Section Calendrier de facturation > Date de la prochaine facturation > La date de la prochaine facture, selon le calendrier de facturation.
summary_owner_internalId varchar2 itgen_vnet_summary_owner_internalid filtres sur la plateforme, modifiables, summary.owner.internalId
summary_owner_name varchar2 itgen_vnet_summary_owner_name filtres sur la plateforme, modifiables, summary.owner.name Le nom de la destination particulière du type sélectionné.
summary_owner_number varchar2 itgen_vnet_summary_owner_number filtres sur la plateforme, modifiables, summary.owner.number L'identifiant de la destination particulière du type sélectionné.
summary_renewalPoint int32 itgen_vnet_summary_renewalpoint filtres sur la plateforme, modifiables, summary.renewalPoint Section Paramètres du contrat > Point de renouvellement > Le nombre de jours avant l'expiration à partir duquel le processus de renouvellement doit commencer.
summary_salesPerson_description varchar2 itgen_vnet_summary_salesperson_description filtres sur la plateforme, modifiables, summary.salesPerson.description Cliquez sur la loupe. > La description.
summary_salesPerson_id varchar2 itgen_vnet_summary_salesperson_id filtres sur la plateforme, modifiables, summary.salesPerson.id Cliquez sur la loupe. > L'identifiant.
summary_setupDate datetime itgen_vnet_summary_setupdate filtres sur la plateforme, modifiables, summary.setupDate Champ obligatoire : Section Paramètres du contrat > Date de configuration* > La date de configuration du contrat.
summary_terminationDate datetime itgen_vnet_summary_terminationdate filtres sur la plateforme, modifiables, summary.terminationDate Section Paramètres du contrat > Date de résiliation > La date à laquelle le contrat sera annulé ; aucun service ne sera fourni.
timeStamp blob Timestamp filtres sur la plateforme, modifiables, timeStamp Identifiant qui représente une version spécifique de la ressource.Permet d'éviter que des mises à jour simultanées de la ressource s'écrasent mutuellement (en utilisant les ETags et les en-têtes If-Match).

Clés

Key Column Se réfère à Kind Description
CustomerContracts_customer_number_fk customer_number Customers.number Key

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 :