invantive documentation
Invantive SupportforenAnmelden / Eintragen

CustomerContractsByContractId: Visma.net Financials Kundenverträge nach Vertrags-ID

read only REST

  • Katalog: VismaNet
  • Schema: CustomerContract
  • Bezeichnung: Kundenverträge nach Vertrags-ID

Bestimmte Kundenvertragsdaten für den Kundenvertrag abrufen. Die Antwort-Header enthalten nach einem erfolgreichen GET-Vorgang einen ETag.

Es können nur Daten abgerufen werden.

Zusammenfassung

Daten für den Kundenvertrag

Die Antwort-Header enthalten nach einem erfolgreichen GET-Vorgang einen ETag.

API-Quelle

  • Endpunkt: /v1/customerContract/{contractId}
  • Operation: get /v1/customerContract/{contractId}

Leistungsmerkmale

Characteristic Value
Durchschnittliche Zugriffsverzögerung (ms) 155
Anzahl der Vollscan-Zeilen pro Minute 29,100
Anzahl der Query-Zeilen pro Minute 387

Das Ergebnis kann auf dem Client im Cache zwischengespeichert werden.

Parameter

Name Datentyp Required Default Documentation
contractId `` Identifiziert den Kundenvertrag

Tabellenspalten

Die Spalten der Tabelle CustomerContractsByContractId sind unten aufgeführt. Jede Spalte hat einen SQL-Datentyp. Beim Einfügen und Aktualisieren muss für jede erforderliche Spalte jederzeit ein neuer Wert angegeben werden der nicht Null ist.

Name Datentyp Label Required Marks Documentation
COMPANY_CODE varchar2(30) Firmencode writable Partitionscode, der die Daten segmentiert.
COMPANY_NAME varchar2(240) Firmenname writable Name der Partition.
balance double Balance Filter auf der Plattform, beschreibbar, balance Der obere Teil > Saldo > Ein Feld nur zum Lesen, das die Summe der Salden offener Rechnungen zum Vertrag anzeigt.
contractId varchar2 Vertrag ID Filter auf der Plattform, beschreibbar, contractId Pflichtfeld: Der obere Teil > Vertrags-ID* > Die eindeutige Kennung eines Vertrags.
contractTemplate_description varchar2 Beschreibung der Vertragsschablone Filter auf der Plattform, beschreibbar, contractTemplate.description Auf die Lupe klicken. > Die Beschreibung.
contractTemplate_id varchar2 Vertragsschablonen-ID Filter auf der Plattform, beschreibbar, contractTemplate.id Auf die Lupe klicken. > Die Kennung.
customer_name varchar2 Name des Kunden Filter auf der Plattform, beschreibbar, customer.name Auf die Lupe klicken. > Der Name.
customer_number varchar2 Kundennummer Filter auf der Plattform, beschreibbar, customer.number
description varchar2 Description Filter auf der Plattform, beschreibbar, description Pflichtfeld: Der obere Teil > Beschreibung* > Die Beschreibung des Vertrags, einschließlich aller zugehörigen Kommentare.
details_currentRecurring double itgen_vnet_details_currentrecurring Filter auf der Plattform, beschreibbar, details.currentRecurring
details_currentRenewal double itgen_vnet_details_currentrenewal Filter auf der Plattform, beschreibbar, details.currentRenewal
details_currentSetup double itgen_vnet_details_currentsetup Filter auf der Plattform, beschreibbar, details.currentSetup
details_effectiveFrom datetime itgen_vnet_details_effectivefrom Filter auf der Plattform, beschreibbar, details.effectiveFrom
details_pendingRecurring double itgen_vnet_details_pendingrecurring Filter auf der Plattform, beschreibbar, details.pendingRecurring
details_pendingRenewal double itgen_vnet_details_pendingrenewal Filter auf der Plattform, beschreibbar, details.pendingRenewal
details_pendingSetup double itgen_vnet_details_pendingsetup Filter auf der Plattform, beschreibbar, details.pendingSetup
details_promoCode_description varchar2 itgen_vnet_details_promocode_description Filter auf der Plattform, beschreibbar, details.promoCode.description Auf die Lupe klicken. > Die Beschreibung.
details_promoCode_id varchar2 itgen_vnet_details_promocode_id Filter auf der Plattform, beschreibbar, details.promoCode.id Auf die Lupe klicken. > Die Kennung.
details_totalPending double Gesamtzahl der noch offenen Fälle Filter auf der Plattform, beschreibbar, details.totalPending
lastModifiedDateTime datetime Letzte Änderung Filter auf der Plattform, beschreibbar, lastModifiedDateTime Systemgenerierte Informationen
location_description varchar2 Lage Beschreibung Filter auf der Plattform, beschreibbar, location.description Auf die Lupe klicken. > Die Beschreibung.
location_id varchar2 Standort-ID Filter auf der Plattform, beschreibbar, location.id Auf die Lupe klicken. > Die Kennung.
status varchar2 Status Filter auf der Plattform, beschreibbar, status Der obere Teil > Status > Der Status des Vertrags, einer der folgenden: Entwurf, Aktivierung ausstehend, Aktiv, Abgelaufen, Storniert, Aktualisierung ausstehend.
summary_activationDate datetime Aktivierungsdatum Filter auf der Plattform, beschreibbar, summary.activationDate Vertragseinstellungen-Abschnitt > Aktivierungsdatum > Das Datum, an dem die Bereitstellung der Vertragsleistungen beginnt.
summary_caseCountItem_description varchar2 itgen_vnet_summary_casecountitem_description Filter auf der Plattform, beschreibbar, summary.caseCountItem.description Bezeichnung des Postens/Beschreibung
summary_caseCountItem_number varchar2 itgen_vnet_summary_casecountitem_number Filter auf der Plattform, beschreibbar, summary.caseCountItem.number Anzahl des Postens
summary_currency varchar2 Currency Filter auf der Plattform, beschreibbar, summary.currency Pflichtfeld: Vertragseinstellungen-Abschnitt > Währung* > Die im Vertrag verwendete Währung.
summary_expirationDate datetime Ablaufdatum Filter auf der Plattform, beschreibbar, summary.expirationDate Vertragseinstellungen-Abschnitt > Ablaufdatum > Das Datum, an dem der Vertrag abläuft.
summary_gracePeriod int32 Nachfrist Filter auf der Plattform, beschreibbar, summary.gracePeriod Vertragseinstellungen-Abschnitt > Nachfrist > Die Anzahl Tage nach dem Ablaufdatum, innerhalb derer der Vertrag noch verlängert werden kann.
summary_invoiceAccount_name varchar2 itgen_vnet_summary_invoiceaccount_name Filter auf der Plattform, beschreibbar, summary.invoiceAccount.name Auf die Lupe klicken. > Der Name.
summary_invoiceAccount_number varchar2 itgen_vnet_summary_invoiceaccount_number Filter auf der Plattform, beschreibbar, summary.invoiceAccount.number
summary_invoiceLocation_description varchar2 itgen_vnet_summary_invoicelocation_description Filter auf der Plattform, beschreibbar, summary.invoiceLocation.description Auf die Lupe klicken. > Die Beschreibung.
summary_invoiceLocation_id varchar2 itgen_vnet_summary_invoicelocation_id Filter auf der Plattform, beschreibbar, summary.invoiceLocation.id Auf die Lupe klicken. > Die Kennung.
summary_invoiceTo varchar2 itgen_vnet_summary_invoiceto Filter auf der Plattform, beschreibbar, summary.invoiceTo Rechnungsinformationen-Abschnitt > Rechnung an > Die Einstellung, die das Kundenkonto festlegt, dem für einen Vertrag in Rechnung gestellt wird.Folgende Optionen sind verfügbar: Hauptkonto, Kundenkonto, Spezifisches Konto.
summary_invoicingPeriod varchar2 itgen_vnet_summary_invoicingperiod Filter auf der Plattform, beschreibbar, summary.invoicingPeriod Pflichtfeld: Rechnungsstellungsplan-Abschnitt > Abrechnungszeitraum* > Die Art des Rechnungsstellungsplans, die eine der folgenden Optionen sein kann: wöchentlich, monatlich; vierteljährlich, halbjährlich, jährlich, auf Abruf, auf Kontoauszug basierend.
summary_invoicingScheduleStartsOn datetime itgen_vnet_summary_invoicingschedulestartson Filter auf der Plattform, beschreibbar, summary.invoicingScheduleStartsOn Rechnungsstellungsplan-Abschnitt > Rechnungsstellungsplan beginnt am > Ein Feld nur zum Lesen, das das Startdatum des ersten Abrechnungszeitraums anzeigt.
summary_lastInvoicingDate datetime itgen_vnet_summary_lastinvoicingdate Filter auf der Plattform, beschreibbar, summary.lastInvoicingDate Rechnungsstellungsplan-Abschnitt > Letztes Rechnungsdatum > Ein Feld nur zum Lesen, das das Datum anzeigt, an dem zuletzt abgerechnet wurde.
summary_massRenewal char itgen_vnet_summary_massrenewal Filter auf der Plattform, beschreibbar, summary.massRenewal Vertragseinstellungen-Abschnitt > Massenverlängerung > Kontrollkästchen, das angibt, dass alle Verträge am Ablaufdatum verlängert werden.
summary_nextInvoicingDate datetime itgen_vnet_summary_nextinvoicingdate Filter auf der Plattform, beschreibbar, summary.nextInvoicingDate Rechnungsstellungsplan-Abschnitt > Nächstes Rechnungsdatum > Das Datum der nächsten Rechnung gemäß Rechnungsstellungsplan.
summary_owner_internalId varchar2 itgen_vnet_summary_owner_internalid Filter auf der Plattform, beschreibbar, summary.owner.internalId
summary_owner_name varchar2 itgen_vnet_summary_owner_name Filter auf der Plattform, beschreibbar, summary.owner.name Der Name des jeweiligen Ziels des ausgewählten Typs.
summary_owner_number varchar2 itgen_vnet_summary_owner_number Filter auf der Plattform, beschreibbar, summary.owner.number Die Kennung des jeweiligen Ziels des ausgewählten Typs.
summary_renewalPoint int32 itgen_vnet_summary_renewalpoint Filter auf der Plattform, beschreibbar, summary.renewalPoint Vertragseinstellungen-Abschnitt > Verlängerungszeitpunkt > Die Anzahl Tage vor Ablauf, zu denen der Verlängerungsprozess beginnen soll.
summary_salesPerson_description varchar2 itgen_vnet_summary_salesperson_description Filter auf der Plattform, beschreibbar, summary.salesPerson.description Auf die Lupe klicken. > Die Beschreibung.
summary_salesPerson_id varchar2 itgen_vnet_summary_salesperson_id Filter auf der Plattform, beschreibbar, summary.salesPerson.id Auf die Lupe klicken. > Die Kennung.
summary_setupDate datetime itgen_vnet_summary_setupdate Filter auf der Plattform, beschreibbar, summary.setupDate Pflichtfeld: Vertragseinstellungen-Abschnitt > Einrichtungsdatum* > Das Datum der Vertragseinrichtung.
summary_terminationDate datetime itgen_vnet_summary_terminationdate Filter auf der Plattform, beschreibbar, summary.terminationDate Vertragseinstellungen-Abschnitt > Kündigungsdatum > Das Datum, an dem der Vertrag gekündigt wird; es werden keine Leistungen mehr erbracht.
timeStamp blob Timestamp Filter auf der Plattform, beschreibbar, timeStamp Kennung, die eine bestimmte Version der Ressource darstellt.Es hilft zu verhindern, dass sich gleichzeitige Aktualisierungen der Ressource gegenseitig überschreiben (durch Verwendung von ETags und If-Match-Headern).

Anmerkungen zu dieser Version

Was hat sich in den Tabellen, Spalten, Attributen und Funktionen des Treibers mit jeder neuen Version geändert: