Zum Inhalt springen

TaxJar Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.9039 des Connectors.

Erste Schritte

TaxJar Versionsunterstützung

Der Connector nutzt Version 2 der TaxJar API, um einen bidirektionalen Zugriff auf TaxJar zu ermöglichen.

Herstellen einer Verbindung

Authentifizieren eines TaxJar-Kontos

Um sich bei der TaxJar API zu authentifizieren, müssen Sie zunächst den API Schlüssel von der TaxJar-Benutzeroberfläche abrufen. Denken Sie daran, dass die API nur für die TaxJar Pläne Professional und Premium verfügbar ist. Wenn Sie bereits über einen Professional- oder Premium-Plan verfügen, können Sie den API-Schlüssel finden, indem Sie sich bei der TaxJar-Benutzeroberfläche anmelden und zu Konto-> TaxJar API gehen. Nachdem Sie den API Schlüssel erhalten haben, können Sie Folgendes festlegen: APIKey Verbindungseigenschaft. Das ist alles, was Sie für eine erfolgreiche Verbindung tun müssen.

Zusätzliche Hinweise
  • Standardmäßig ruft der Connector Daten der letzten 3 Monate ab, falls die Entität die Datumsbereichsfilterung unterstützt. Sie können verwenden StartDate um das Mindesterstellungsdatum der abgerufenen Daten festzulegen.
  • Wenn der API Schlüssel für ein Sandbox API Konto erstellt wurde, setzen Sie bitte UseSandbox auf true, damit eine erfolgreiche Verbindung hergestellt werden kann.
  • Falls Sie ein Sandbox-API -Konto verwenden, denken Sie bitte daran, dass nicht alles wie erwartet funktioniert. Dies ist auch in den TaxJar Entwickler hier dokumentiert: Sandbox-Umgebung und hier: Nicht unterstützte Endpoints
  • Die Ratenbegrenzung der TaxJar API ist wirklich großzügig. (10.000 Anfragen pro Minute für TaxJar Professional-Pläne und 25.000 pro Minute für die TaxJar Premium-Pläne).
  • Aufgrund der TaxJar API -Beschränkungen sind wir darauf beschränkt, für jede Zeile eine HTTP-Anfrage zu stellen, um so viele Daten wie möglich zu sammeln. Wir empfehlen, den Wert von zu erhöhen MaxThreads Verbindungseigenschaft.
  • Der Standardwert von MaxThreads wurde auf 20 gesetzt, was bedeutet, dass maximal 20 gleichzeitige Anfragen gestellt werden. Um die Leistung des Connectors zu verbessern, sollten Sie diesen Wert basierend auf den Maschinenressourcen erhöhen.

Wichtige Hinweise

Konfigurationsdateien und ihre Pfade

  • Alle Verweise auf das Hinzufügen von Konfigurationsdateien und deren Pfaden beziehen sich auf Dateien und Speicherorte auf dem Jitterbit-Agenten, auf dem der Connector installiert ist. Diese Pfade sind je nach Agent und Operationssystem entsprechend anzupassen. Wenn mehrere Agenten in einer Agentengruppe verwendet werden, werden auf jedem Agenten identische Dateien benötigt.

Erweiterte Funktionen

In diesem Abschnitt wird eine Auswahl erweiterter Funktionen des TaxJar Konnektors beschrieben.

Benutzerdefinierte Ansichten

Der Connector ermöglicht Ihnen die Definition virtueller Tabellen, sogenannter benutzerdefinierter Ansichten, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese Ansichten sind nützlich, wenn Sie die an die Treiber gesendeten Abfragen nicht direkt steuern können. Siehe Benutzerdefinierte Ansichten für einen Überblick über das Erstellen und Konfigurieren benutzerdefinierter Ansichten.

SSL-Konfiguration

Verwenden Sie SSL-Konfiguration, um anzupassen, wie der Connector TLS/SSL-Zertifikatsverhandlungen handhabt. Sie können aus verschiedenen Zertifikatsformaten wählen; siehe SSLServerCert-Eigenschaft unter „Verbindungszeichenfolgenoptionen“ für weitere Informationen.

Proxy

So konfigurieren Sie den Connector mit privaten Agent-Proxy-Einstellungen, wählen Sie die Use Proxy Settings Kontrollkästchen auf dem Verbindungskonfigurationsbildschirm.

Abfrageverarbeitung

Der Connector verlagert möglichst viel der Verarbeitung der SELECT-Anweisung auf TaxJar und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem TaxJar-Connector können Sie eine virtuelle Tabelle definieren, deren Inhalt durch eine vorkonfigurierte Abfrage bestimmt wird. Diese werden als benutzerdefinierte Ansichten bezeichnet und sind in Situationen nützlich, in denen Sie die an den Treiber gesendete Abfrage nicht direkt steuern können, z. B. wenn Sie den Treiber von Jitterbit verwenden. Die benutzerdefinierten Ansichten können verwendet werden, um Prädikate zu definieren, die immer angewendet werden. Wenn Sie in der Abfrage an die Ansicht zusätzliche Prädikate angeben, werden diese mit der bereits als Teil der Ansicht definierten Abfrage kombiniert.

Es gibt zwei Möglichkeiten, benutzerdefinierte Ansichten zu erstellen:

  • Erstellen Sie eine Konfigurationsdatei im JSON-Format, die die gewünschten Ansichten definiert.
  • DDL-Anweisungen.

Definieren von Ansichten mithilfe einer Konfigurationsdatei

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die UserDefinedViews Verbindungseigenschaft zur Angabe des Speicherorts Ihrer JSON-Konfigurationsdatei. Beispiel:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Definieren von Ansichten mit DDL-Anweisungen

Der Connector kann das Schema auch über DDL-Anweisungen wie CREATE LOCAL VIEW, ALTER LOCAL VIEW und DROP LOCAL VIEW erstellen und ändern.

Erstellen einer Ansicht

Um eine neue Ansicht mit DDL-Anweisungen zu erstellen, geben Sie den Ansichtsnamen und die Abfrage wie folgt an:

CREATE LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers LIMIT 20;

Wenn keine JSON-Datei vorhanden ist, erstellt der obige Code eine. Die Ansicht wird dann in der JSON-Konfigurationsdatei erstellt und ist nun erkennbar. Der Speicherort der JSON-Datei wird durch angegeben UserDefinedViews Verbindungseigenschaft.

Ändern einer Ansicht

Um eine vorhandene Ansicht zu ändern, geben Sie den Namen der vorhandenen Ansicht zusammen mit der neuen Abfrage an, die Sie stattdessen verwenden möchten:

ALTER LOCAL VIEW`[MeinAnsichtsname] `AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

Die Ansicht wird dann in der JSON-Konfigurationsdatei aktualisiert.

Löschen einer Ansicht

Um eine vorhandene Ansicht zu löschen, geben Sie den Namen eines vorhandenen Schema neben der neuen Abfrage an, die Sie stattdessen verwenden möchten.

DROP LOCAL VIEW [MyViewName]

Dadurch wird die Ansicht aus der JSON-Konfigurationsdatei entfernt. Sie kann nicht mehr abgefragt werden.

Schema für benutzerdefinierte Ansichten

Benutzerdefinierte Ansichten werden im angezeigt UserViews Schema standardmäßig. Dies geschieht, um zu vermeiden, dass der Name der Ansicht mit einer tatsächlichen Entität im Datenmodell kollidiert. Sie können den Namen des für UserViews verwendeten Schema ändern, indem Sie festlegen UserViewsSchemaName Eigentum.

Arbeiten mit benutzerdefinierten Ansichten

Beispielsweise eine SQL-Anweisung mit einer benutzerdefinierten Ansicht namens UserViews.RCustomers listet nur Kunden in Raleigh auf:

SELECT * FROM Customers WHERE City = 'Raleigh';

Ein Beispiel für eine Abfrage an den Treiber:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Daraus ergibt sich die effektive Abfrage an die Quelle:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Dies ist ein sehr einfaches Beispiel für eine Abfrage an eine benutzerdefinierte Ansicht, die tatsächlich eine Kombination aus der Abfrage und der Ansichtsdefinition ist. Es ist möglich, diese Abfragen in viel komplexeren Mustern zusammenzustellen. Alle SQL-Operationen sind in beiden Abfragen zulässig und werden bei Bedarf kombiniert.

SSL-Konfiguration

Anpassen der SSL-Konfiguration

Standardmäßig versucht der Connector, SSL/TLS auszuhandeln, indem er das Zertifikat des Servers mit dem vertrauenswürdigen Zertifikatspeicher des Systems vergleicht.

Um ein anderes Zertifikat anzugeben, siehe SSLServerCert Eigenschaft für die verfügbaren Formate, um dies zu tun.

Datenmodell

Überblick

Dieser Abschnitt zeigt die verfügbaren API Objekte und bietet weitere Informationen zur Ausführung von SQL für TaxJar APIs.

Hauptmerkmale

  • Der Connector modelliert TaxJar Entitäten wie Dokumente, Ordner und Gruppen als relationale Ansichten, sodass Sie SQL schreiben können, um TaxJar Daten Abfrage.
  • Gespeicherte Prozeduren ermöglichen Ihnen die Ausführung von Operationen an TaxJar
  • Die Live-Konnektivität zu diesen Objekten bedeutet, dass alle Änderungen an Ihrem TaxJar-Konto bei Verwendung des Connectors sofort angezeigt werden.

Ansichten

Ansichten beschreibt die verfügbaren Ansichten. Ansichten werden statisch definiert, um Kategorien, Bestellpositionen und mehr zu modellieren.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen. Tabellen werden statisch definiert, um Kunden, Bestellungen und Rückerstattungen zu modellieren.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zu TaxJar. Gespeicherte Prozeduren ermöglichen Ihnen die Ausführung von Operationen an TaxJar, einschließlich der Berechnung der Umsatzsteuer und der Validierung von Adressen.

Tabellen

Der Connector modelliert die Daten in TaxJar als Liste von Tabellen in einer relationalen Datenbank, die mit Standard-SQL-Anweisungen abgefragt werden können.

TaxJar Connector-Tabellen

Name Beschreibung
Customers Listet bestehende Kunden auf.
Orders Listet bestehende Bestellvorgänge auf.
Refunds Listet vorhandene Rückerstattungstransaktionen auf.

Kunden

Listet bestehende Kunden auf.

Wählen

Der Connector verwendet die TaxJar API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • CustomerID unterstützt die folgenden Operatoren: =,IN

Die folgenden Abfragen werden serverseitig verarbeitet:

SELECT * FROM Customers WHERE CustomerID = '123'
SELECT * FROM Customers WHERE CustomerID IN ('123', '1234')
Einfügen

Um eine Bestellung hinzuzufügen, müssen mindestens die Transaktions-ID, das Transaktionsdatum, das Zielland, die Ziel-PLZ, der Zielstaat, der Betrag, der Versand und die Umsatzsteuer angegeben werden. Außerdem kann der Connector einen Insert auf zwei Arten ausführen.
Verwenden eines Aggregats zum Angeben der ausgenommenen Regionen:

INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue',
'[
{
"country": "US",
"state": "FL"
},
{
"country": "US",
"state": "PA"
}
]')

Oder verwenden Sie temporäre Tabellen, um die ausgenommenen Regionen anzugeben:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')

INSERT INTO Customers (CustomerID, ExemptionType, Name, Country, State, ZIP, City, Street, ExemptRegionsAggregate)
VALUES ('123', 'wholesale', 'Dunder Mifflin Paper Company', 'US', 'PA', '18504', 'Scranton', '1725 Slough Avenue', 'CustomerExemptRegions#TEMP')
Aktualisieren

Ähnlich wie beim Operation kann der Connector ein Element auf zwei Arten aktualisieren.
Verwenden eines Aggregats zum Angeben der ausgenommenen Regionen:

UPDATE Customers SET CustomerID = '123', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = '[
      {
        "country": "US",
        "state": "FL"
      },
      {
        "country": "US",
        "state": "PA"
      }
]' WHERE CustomerID = 123

Und Verwendung temporärer Tabellen zur Angabe der ausgenommenen Regionen:

INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('PA', 'US')
INSERT INTO CustomerExemptRegions#TEMP (State, Country) VALUES ('FL', 'US')
UPDATE Customers SET CustomerID = '1', ExemptionType = 'non_exempt', Name = 'egi', Country = 'US', State = 'CA', ZIP = '90002', City = 'Los Angeles', Street = '123 Palm Grove Ln', ExemptRegionsAggregate = 'CustomerExemptRegions#TEMP' WHERE CustomerID = 123
Löschen

Um einen Kunden zu löschen, muss beispielsweise die Kunden-ID angegeben werden.

DELETE FROM Customers WHERE CustomerID = '100'
Spalten
Name Typ Nur Lesen Beschreibung
CustomerID [KEY] String Falsch Eindeutige Kennung des angegebenen Kunden.
ExemptionType String Falsch Art der Kundenbefreiung: Großhandel, Staat, Sonstiges oder nicht_befreit.
Name String Falsch Name des Kunden.
Country String Falsch Zweistelliger ISO-Ländercode der primären Adresse des Kunden.
State String Falsch Zweistelliger ISO-Staatscode der Hauptadresse des Kunden.
ZIP String Falsch Postleitzahl der Hauptadresse des Kunden.
City String Falsch Stadt der Hauptadresse des Kunden.
Street String Falsch Straßenadresse der Hauptadresse des Kunden.
ExemptRegionsAggregate String Falsch Orte, an denen der Kunde von der Steuer befreit ist.

Bestellungen

Listet vorhandene Bestelltransaktionen auf.

Wählen

Der Connector verwendet die TaxJar API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • TransactionDate unterstützt die folgenden Operatoren: <,<=,=,>,>=
  • TransactionID unterstützt die folgenden Operatoren: =,IN
  • Provider unterstützt den folgenden Operator: = (Standardmäßig ist der Provider auf „API“ eingestellt, was bedeutet, dass nur Daten abgerufen werden, die von der API erstellt wurden.)

Für die folgende Abfrage:

SELECT * FROM TableName

Wir haben diese 2 Fälle:

  • StartDate Verbindungseigenschaft ist nicht festgelegt. Der Connector ruft Daten der letzten 3 Monate ab.
  • StartDate Verbindungseigenschaft ist festgelegt. Der Connector ruft Daten vom angegebenen Startdatum bis heute ab.

Die folgenden Abfragen werden serverseitig verarbeitet:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'
Einfügen

Um eine Bestellung hinzuzufügen, müssen mindestens die Transaktions-ID, das Transaktionsdatum, das Zielland, die Ziel-PLZ, der Zielstaat, der Betrag, der Versand und die Umsatzsteuer angegeben werden. Außerdem können wir einen Einfügevorgang auf zwei Arten ausführen.
Verwenden eines Aggregats zum Angeben der Einzelposten:

INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1,
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
]')

Oder verwenden Sie temporäre Tabellen, um die Einzelposten anzugeben:

INSERT INTO`[OrderLineItems#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO`[OrderLineItems#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Orders (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
"VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'OrderLineItems#TEMP')
Aktualisieren

Ähnlich wie beim Operation können wir ein Element auf zwei Arten aktualisieren.
Verwenden eines Aggregats zum Angeben der Einzelposten:

UPDATE Orders SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC',
FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1,
LineItemsAggregate = '[
{
"id": 2,
"quantity": 2,
"product_identifier": "22-22222-2",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
},
{
"id": 1,
"quantity": 1,
"product_identifier": "11-11111-1",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
}
]'

Und Verwendung temporärer Tabellen zur Angabe der Einzelposten:

INSERT INTO`[OrderLineItems#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO`[OrderLineItems#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Orders SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'OrderLineItems#TEMP' WHERE TransactionID = '123'
Löschen

Um eine Bestellung zu löschen, muss beispielsweise die Transaktions-ID angegeben werden.

DELETE FROM Orders WHERE TransactionID = '100'
Spalten
Name Typ Nur Lesen Beschreibung
TransactionID [KEY] String Falsch Eindeutige Kennung der angegebenen Bestelltransaktion.
UserID Int Falsch Eindeutige Kennung des Benutzers, der die Bestelltransaktion erstellt hat.
TransactionDate Date Falsch Das Datum/die Uhrzeit, zu der die Transaktion ursprünglich aufgezeichnet wurde.
Provider String Falsch Quelle, wo die Transaktion ursprünglich aufgezeichnet wurde.
ExemptionType String Falsch Art der Befreiung für die Bestellung: Großhandel, Regierung, Marktplatz, Sonstiges, nicht befreit oder null.
FromCountry String Falsch Zweistelliger ISO-Ländercode des Landes, aus dem die Bestellung versendet wurde.
FromZip String Falsch Postleitzahl des Versandorts der Bestellung (5-stellige ZIP oder ZIP+4).
FromState String Falsch Zweistelliger ISO-Code des Staates, aus dem die Bestellung versendet wurde.
FromCity String Falsch Stadt, aus der die Bestellung versendet wurde.
FromStreet String Falsch Straßenadresse, von der die Bestellung versendet wurde.
ToCountry String Falsch Zweistelliger ISO-Ländercode des Landes, in das die Bestellung geliefert wurde.
ToZip String Falsch Postleitzahl, an die die Bestellung geliefert wurde (5-stellige ZIP oder ZIP+4).
ToState String Falsch Zweistelliger ISO-Code des Staates, in den die Bestellung geliefert wurde.
ToCity String Falsch Stadt, in die die Bestellung geliefert wurde.
ToStreet String Falsch Straßenadresse, an die die Bestellung geliefert wurde.
Amount Double False Gesamtbetrag der Bestellung inklusive Versand, exkl. Umsatzsteuer.
Shipping Double Falsch Gesamtversandbetrag für die Bestellung.
SalesTax Double Falsch Gesamtbetrag der für die Bestellung eingezogenen Umsatzsteuer.
LineItemsAggregate String Falsch Straßenadresse, an die die Bestellung geliefert wurde.

Rückerstattungen

Listet vorhandene Rückerstattungstransaktionen auf.

Wählen

Der Connector verwendet die TaxJar API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • TransactionDate unterstützt die folgenden Operatoren: <,<=,=,>,>=
  • TransactionID unterstützt die folgenden Operatoren: =,IN
  • Provider unterstützt den folgenden Operator: = (Standardmäßig ist der Provider auf „API“ eingestellt, was bedeutet, dass nur Daten abgerufen werden, die von der API erstellt wurden.)

Für die folgende Abfrage:

SELECT * FROM TableName

Wir haben diese 2 Fälle:

  • StartDate Verbindungseigenschaft ist nicht festgelegt. Der Connector ruft Daten der letzten 3 Monate ab.
  • StartDate Verbindungseigenschaft ist festgelegt. Der Connector ruft Daten vom angegebenen Startdatum bis heute ab.

Die folgenden Abfragen werden serverseitig verarbeitet:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'
Einfügen

Um eine Bestellung hinzuzufügen, müssen mindestens die Transaktions-ID, das Transaktionsdatum, das Zielland, die Ziel-PLZ, der Zielstaat, der Betrag, der Versand und die Umsatzsteuer angegeben werden. Außerdem können wir einen Einfügevorgang auf zwei Arten ausführen.
Verwenden eines Aggregats zum Angeben der Einzelposten:

INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
        VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1,
     '[
        {
          "id": 2,
          "quantity": 2,
          "product_identifier": "22-22222-2",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        },
        {
          "id": 1,
          "quantity": 1,
          "product_identifier": "11-11111-1",
          "description": "Fuzzy Widget",
          "unit_price": 5,
          "sales_tax": 0.0
        }
]')

Oder verwenden Sie temporäre Tabellen, um die Einzelposten anzugeben:

INSERT INTO`[Rückerstattungspositionen#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO`[Rückerstattungspositionen#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
INSERT INTO Refunds (TransactionID, UserID, TransactionDate, Provider, ExemptionType, FromCountry, FromZip, FromState, FromCity, FromStreet, ToCountry, ToZip, ToState, ToCity, ToStreet, Amount, Shipping, SalesTax, LineItemsAggregate)
"VALUES ('123', '2', '2015/05/05', 'api', 'non_exempt', 'US', '', 'NC', '', '', 'US', '90002', 'CA', 'Los Angeles', '123 Palm Grove Ln', '15', '0', 1, 'RefundLineItems#TEMP')
Aktualisieren

Ähnlich wie beim Operation können wir ein Element auf zwei Arten aktualisieren.
Verwenden eines Aggregats zum Angeben der Einzelposten:

UPDATE Refunds SET TransactionID = '111', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC',
FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1,
LineItemsAggregate = '[
{
"id": 2,
"quantity": 2,
"product_identifier": "22-22222-2",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
},
{
"id": 1,
"quantity": 1,
"product_identifier": "11-11111-1",
"description": "Fuzzy Widget",
"unit_price": 5,
"sales_tax": 0.0
}
]'

Und Verwendung temporärer Tabellen zur Angabe der Einzelposten:

INSERT INTO`[Rückerstattungspositionen#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('1', '1', '11-11111-1', 'description 1', '', '5', '', '0.0')
INSERT INTO`[Rückerstattungspositionen#TEMP] `(ID, Quantity, ProductIdentifier, Description, ProductTaxCode, UnitPrice, Discount, SalesTax) VALUES ('2', '2', '22-22222-2', 'description 2', '', '5', '', '0.0')
UPDATE Refunds SET TransactionID = '123', UserID = '2', TransactionDate = '2015/05/05', Provider = 'api', ExemptionType = 'non_exempt', FromCountry = 'US', FromZip = '', FromState = 'NC', FromCity = '', FromStreet = '', ToCountry = 'US', ToZip = '90002', ToState = 'CA', ToCity = 'Los Angeles', ToStreet = '123 Palm Grove Ln', Amount = '15', Shipping = '0', SalesTax = 1, LineItemsAggregate = 'RefundLineItems#TEMP' WHERE TransactionID = '123'
Löschen

Um eine Rückerstattung zu löschen, muss beispielsweise die Transaktions-ID angegeben werden.

DELETE FROM Refunds WHERE TransactionID = '100'
Spalten
Name Typ Nur Lesen Beschreibung
TransactionID [KEY] String Falsch Eindeutige Kennung der angegebenen Rückerstattungstransaktion.
TransactionReferenceID String False Eindeutige Kennung der entsprechenden Bestelltransaktion für die Rückerstattung.
UserID Int Falsch Eindeutige Kennung des Benutzers, der die Rückerstattungstransaktion erstellt hat.
TransactionDate Date Falsch Das Datum/die Uhrzeit, zu der die Transaktion ursprünglich aufgezeichnet wurde.
Provider String Falsch Quelle, wo die Transaktion ursprünglich aufgezeichnet wurde.
ExemptionType String Falsch Art der Befreiung für die Bestellung: Großhandel, Regierung, Marktplatz, Sonstiges, nicht befreit oder null.
FromCountry String Falsch Zweistelliger ISO-Ländercode des Landes, aus dem die Bestellung versendet wurde.
FromZip String Falsch Postleitzahl des Versandorts der Bestellung (5-stellige ZIP oder ZIP+4).
FromState String Falsch Zweistelliger ISO-Code des Staates, aus dem die Bestellung versendet wurde.
FromCity String Falsch Stadt, aus der die Bestellung versendet wurde.
FromStreet String Falsch Straßenadresse, von der die Bestellung versendet wurde.
ToCountry String Falsch Zweistelliger ISO-Ländercode des Landes, in das die Bestellung geliefert wurde.
ToZip String Falsch Postleitzahl, an die die Bestellung geliefert wurde (5-stellige ZIP oder ZIP+4).
ToState String Falsch Zweistelliger ISO-Code des Staates, in den die Bestellung geliefert wurde.
ToCity String Falsch Stadt, in die die Bestellung geliefert wurde.
ToStreet String Falsch Straßenadresse, an die die Bestellung geliefert wurde.
Amount Double Falsch Gesamtbetrag der erstatteten Bestellung inklusive Versand, ohne Umsatzsteuer.
Shipping Double Falsch Gesamtversandbetrag für die erstattete Bestellung.
SalesTax Double Falsch Gesamtbetrag der für die erstattete Bestellung eingezogenen Umsatzsteuer.
LineItemsAggregate String Falsch Straßenadresse, an die die Bestellung geliefert wurde.

Ansichten

Ansichten ähneln Tabellen in der Art und Weise, wie Daten dargestellt werden; Ansichten sind jedoch schreibgeschützt.

Abfragen können für eine Ansicht ausgeführt werden, als wäre sie eine normale Tabelle.

TaxJar Connector-Ansichten

Name Beschreibung
Categories Listet alle Steuerkategorien auf.
CustomerExemptRegions Listet ausgenommene Regionen eines Kunden auf.
NexusRegions Listet vorhandene Nexus-Standorte für ein TaxJar-Konto auf.
OrderLineItems Listet bestehende Bestellvorgänge auf.
RefundLineItems Listet die Einzelposten einer Bestelltransaktion auf.
SummarizedRates Rufen Sie die Mindest- und Durchschnittsumsatzsteuersätze nach Region ab.

Kategorien

Listet alle Steuerkategorien auf.

Spalten
Name Typ Beschreibung
ProductTaxCode String Steuercode der angegebenen Produktkategorie.
Name String Name der angegebenen Produktkategorie.
Description String Beschreibung der angegebenen Produktkategorie.

KundenbefreiteRegionen

Listet ausgenommene Regionen eines Kunden auf.

Spalten
Name Typ Beschreibung
CustomerID [KEY] String Eindeutige Kennung des angegebenen Kunden.
State String Zweistelliger ISO-Ländercode, wenn der Kunde davon ausgenommen ist.
Country String Zweistelliger ISO-Code des Staates, in dem der Kunde von der Steuer befreit ist.

NexusRegions

Listet vorhandene Nexus-Standorte für ein TaxJar Konto auf.

Spalten
Name Typ Beschreibung
CountryCode String Zweistelliger ISO-Ländercode für die Nexus-Region.
Country String Ländername für Nexus-Region.
RegionCode String Zweistelliger ISO-Regionalcode für die Nexus-Region.
Region String Regionsname für die Nexus-Region.

Bestellpositionen

Listet vorhandene Bestelltransaktionen auf.

Wählen

Der Connector verwendet die TaxJar API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • TransactionDate unterstützt die folgenden Operatoren: <,<=,=,>,>=
  • TransactionID unterstützt die folgenden Operatoren: =,IN
  • Provider unterstützt den folgenden Operator: = (Standardmäßig ist der Provider auf „API“ eingestellt, was bedeutet, dass nur Daten abgerufen werden, die von der API erstellt wurden.)

Für die folgende Abfrage:

SELECT * FROM TableName

Wir haben diese 2 Fälle:

  • StartDate Verbindungseigenschaft ist nicht festgelegt. Der Connector ruft Daten der letzten 3 Monate ab.
  • StartDate Verbindungseigenschaft ist festgelegt. Der Connector ruft Daten vom angegebenen Startdatum bis heute ab.

Die folgenden Abfragen werden serverseitig verarbeitet:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'
Spalten
Name Typ Beschreibung
TransactionID [KEY] String Eindeutige Kennung der jeweiligen Bestelltransaktion.
TransactionDate Date Datum/Uhrzeit der ursprünglichen Aufzeichnung der Transaktion.
Provider String Quelle, wo die Transaktion ursprünglich aufgezeichnet wurde.
ID [KEY] String Eindeutige Kennung der angegebenen Position.
Quantity Int Menge für den Artikel.
ProductIdentifier String Produktkennung für den Artikel.
Description String Beschreibung der Position (maximal 255 Zeichen).
ProductTaxCode String Produktsteuercode für den Artikel.
UnitPrice Double Stückpreis für den Artikel in Dollar.
Discount Double Gesamtrabatt (ohne Einheit) für den Artikel in Dollar.
SalesTax Double Gesamte eingenommene Umsatzsteuer (ohne Einheit) für den Artikel in Dollar.

Rückerstattungspositionen

Listet Einzelposten einer Bestelltransaktion auf.

Wählen

Der Connector verwendet die TaxJar API, um WHERE-Klauselbedingungen zu verarbeiten, die mit den folgenden Spalten und Operatoren erstellt wurden. Der Rest des Filters wird clientseitig innerhalb des Connectors ausgeführt.

  • TransactionDate unterstützt die folgenden Operatoren: <,<=,=,>,>=
  • TransactionID unterstützt die folgenden Operatoren: =,IN
  • Provider unterstützt den folgenden Operator: = (Standardmäßig ist der Provider auf „API“ eingestellt, was bedeutet, dass nur Daten abgerufen werden, die von der API erstellt wurden.)

Für die folgende Abfrage:

SELECT * FROM TableName

Wir haben diese 2 Fälle:

  • StartDate Verbindungseigenschaft ist nicht festgelegt. Der Connector ruft Daten der letzten 3 Monate ab.
  • StartDate Verbindungseigenschaft ist festgelegt. Der Connector ruft Daten vom angegebenen Startdatum bis heute ab.

Die folgenden Abfragen werden serverseitig verarbeitet:

SELECT * FROM TableName WHERE TransactionID = '200'
SELECT * FROM TableName WHERE Provider = 'ebay'
SELECT * FROM TableName WHERE TransactionID IN ('123', '122')
SELECT * FROM TableName WHERE TransactionDate <= '2020/05/15' AND TransactionDate >= '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15' AND TransactionDate > '2014/05/15'
SELECT * FROM TableName WHERE TransactionDate < '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate > '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate >= '2015/05/15'
SELECT * FROM TableName WHERE TransactionDate = '2015/05/15'
Spalten
Name Typ Beschreibung
TransactionID [KEY] String Eindeutige Kennung der jeweiligen Bestelltransaktion.
TransactionDate Date Datum/Uhrzeit der ursprünglichen Aufzeichnung der Transaktion.
Provider String Quelle, wo die Transaktion ursprünglich aufgezeichnet wurde.
ID [KEY] String Eindeutige Kennung der angegebenen Position.
Quantity Int Menge für den Artikel.
ProductIdentifier String Produktkennung für den Artikel.
Description String Beschreibung der Position (maximal 255 Zeichen).
ProductTaxCode String Produktsteuercode für den Artikel.
UnitPrice Double Stückpreis für den Artikel in Dollar.
Discount Double Gesamtrabatt (ohne Einheit) für den Artikel in Dollar.
SalesTax Double Gesamte eingenommene Umsatzsteuer (ohne Einheit) für den Artikel in Dollar.

ZusammengefasstePreise

Mindest- und Durchschnittsumsatzsteuersätze nach Region abrufen.

Spalten
Name Typ Beschreibung
CountryCode String Zweistelliger ISO-Ländercode für die zusammengefasste Region.
Country String Ländername für zusammengefasste Region.
RegionCode String Zweistelliger ISO-Regionencode für zusammengefasste Regionen.
Region String Regionsname für zusammengefasste Region.
MinimumRateLabel String Nur für Regionen/Bundesländer geltendes Umsatzsteuerlabel.
MinimumRate String Nur regionaler/bundesstaatlicher Umsatzsteuersatz.
AverageRateLabel String Durchschnittliche Rate für das Regional-/Staatslabel.
AverageRate String Durchschnittlicher Satz der regionalen/staatlichen und lokalen Umsatzsteuer für alle Postleitzahlen in der zusammengefassten Region.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen, die die Funktionalität des Connectors über einfache SELECT/INSERT/UPDATE/DELETE-Operationen mit TaxJar hinaus erweitern.

Gespeicherte Prozeduren akzeptieren eine Liste von Parametern, führen ihre beabsichtigte Funktion aus und geben dann alle relevanten Antwortdaten von TaxJar zurück, zusammen mit einer Angabe, ob die Prozedur erfolgreich war oder fehlgeschlagen ist.

Gespeicherte Prozeduren für den TaxJar Connector

Name Beschreibung
CalculateTaxes Zeigt die Umsatzsteuer an, die für eine bestimmte Bestellung erhoben werden soll.
GetTaxRate Steuersätze für einen Standort abrufen.
ValidateAddress Validiert eine Kundenadresse und gibt eine Sammlung von Adressübereinstimmungen zurück.
ValidateVAT Validiert eine vorhandene Umsatzsteuer-Identifikationsnummer

Steuern berechnen

Zeigt die Umsatzsteuer an, die für eine bestimmte Bestellung erhoben werden soll.

Steuern berechnen

Um die Steuern für eine bestimmte Bestellung zu berechnen, muss die gespeicherte Prozedur CalculateTaxes aufgerufen werden. Um einen CalculateTaxes SP-Aufruf durchzuführen, geben Sie bitte mindestens die Parameter ToCountry und Shipping an.

Hinweis: Um „NexusAddresses“ und „LineItems“ mehr als einen Wert hinzuzufügen, können Sie die Tabellen NexusAddresses#TEMP und LineItems#TEMP verwenden oder die JSON-Struktur erstellen, um die einzufügenden Werte bereitzustellen.

Um Fehler zu vermeiden, befolgen Sie bitte die Bedingungen für einen erfolgreichen SP-Aufruf, die von der TaxJar API erzwungen werden:

  • Wenn ToCountry auf US eingestellt ist, ist ToZIP erforderlich.
  • Wenn „ToCountry“ auf „US“ oder „CA“ eingestellt ist, ist „ToState“ erforderlich.
  • Wenn NexusAddresses angegeben werden, sind NexusAddressesCountry und NexusAddressesState erforderlich.
  • Geben Sie entweder den Betrag oder die Einzelposten an, um Steuerberechnungen durchzuführen.
EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddressId = 'Main Location',
@NexusAddressCountry = 'US',
@NexusAddressZip = '92093',
@NexusAddressState = 'CA',
@NexusAddressCity = 'La Jolla',
@NexusAddressStreet = '9500 Gilman Drive'
INSERT INTO NexusAddresses#TEMP (NexusAddressID, NexusAddressCountry, NexusAddressZip, NexusAddressState, NexusAddressCity, NexusAddressStreet) VALUES ('Main Location', 'US', '92093', 'CA', 'La Jolla', '9500 Gilman Drive')
INSERT INTO NexusAddresses#TEMP (NexusAddressID, NexusAddressCountry, NexusAddressZip, NexusAddressState, NexusAddressCity, NexusAddressStreet) VALUES ('Main Location 2', 'US', '92093', 'CA', 'La Jolla 2', '9500 Gilman Drive 2')
INSERT INTO LineItems#TEMP (LineItemId, LineItemQuantity, LineItemProductTaxCode, LineItemUnitPrice, LineItemDiscount) VALUES ('1', '1', '20010', '15', '0')

EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddresses = 'NexusAddresses#TEMP',
@LineItems = 'LineItems#TEMP'
EXEC CalculateTaxes
@FromCountry = 'US',
@FromZip = '92093',
@FromState = 'CA',
@FromCity = 'La Jolla',
@FromStreet = '9500 Gilman Drive',
@ToCountry = 'US',
@ToZip = '90002',
@ToState = 'CA',
@ToCity = 'Los Angeles',
@ToStreet = '1335 E 103rd St',
@Amount = '15',
@Shipping = '1.5',
@NexusAddresses = '[{"NexusAddressId":"Main Location","NexusAddresscountry":"US","NexusAddresszip":"92093","NexusAddressstate":"CA","NexusAddresscity":"La Jolla","NexusAddressstreet":"9500 Gilman Drive"},{"NexusAddressid":"Main Location 2","NexusAddresscountry":"US","NexusAddresszip":"92093","NexusAddressstate":"CA","NexusAddresscity":"La Jolla 2","NexusAddressstreet":"9500 Gilman Drive 2"}]',
@LineItems = '[{"LineItemid":"1","LineItemquantity":"1","LineItemproducttaxcode":"20010","LineItemunitprice":"15","LineItemdiscount":"0"}]'
Eingang
Name Typ Erforderlich Beschreibung
FromCountry String Falsch Zweistelliger ISO-Ländercode des Landes, aus dem die Bestellung versendet wurde. Hinweis anzeigen
FromZip String Falsch Postleitzahl des Versandorts der Bestellung (5-stellige ZIP oder ZIP+4).
FromState String Falsch Zweistelliger ISO-Code des Staates, aus dem die Bestellung versendet wurde.
FromCity String Falsch Stadt, aus der die Bestellung versendet wurde.
FromStreet String Falsch Straßenadresse, von der die Bestellung versendet wurde.
ToCountry String True Zweistelliger ISO-Ländercode des Landes, in das die Bestellung geliefert wurde.
ToZip String Falsch Postleitzahl, an die die Bestellung geliefert wurde (5-stellige Postleitzahl oder Postleitzahl+4).
ToState String Falsch Zweistelliger ISO-Code des Staates, in den die Bestellung geliefert wurde.
ToCity String Falsch Stadt, in die die Bestellung geliefert wurde.
ToStreet String Falsch Straßenadresse, an die die Bestellung geliefert wurde. Notiz anzeigen
Amount Double Falsch Gesamtbetrag der Bestellung ohne Versand. Hinweis anzeigen
Shipping Double True Gesamtversandbetrag für die Bestellung.
CustomerId String Falsch Eindeutige Kennung des angegebenen Kunden für Ausnahmen.
ExemptionType String Falsch Art der Befreiung für die Bestellung: Großhandel, Regierung, Marktplatz, Sonstiges oder nicht befreit.
NexusAddressId String Falsch Eindeutige Kennung der angegebenen Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddressCountry String Falsch Zweistelliger ISO-Ländercode für die Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddressZip String Falsch Postleitzahl für die Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddressState String Falsch Zweistelliger ISO-Staatscode für die Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddressCity String Falsch Stadt für die Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddressStreet String Falsch Straßenadresse für die Nexus-Adresse. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „NexusAddresses“ hinzugefügt wird.
NexusAddresses String Falsch Das Aggregat für Nexus-Adressen.
LineItemId String Falsch Eindeutige Kennung des angegebenen Positionselements. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „LineItems“ hinzugefügt wird.
LineItemQuantity Integer Falsch Menge für den Artikel. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „LineItems“ hinzugefügt wird.
LineItemProductTaxCode String Falsch Produktsteuercode für den Artikel. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „LineItems“ hinzugefügt wird.
LineItemUnitPrice Double Falsch Stückpreis für den Artikel. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „LineItems“ hinzugefügt wird.
LineItemDiscount Double Falsch Gesamtrabatt (keine Einheit) für den Artikel. Diese Spalteneingabe wird nicht akzeptiert, wenn die Spalte „LineItems“ hinzugefügt wird.
LineItems String Falsch Das Aggregat für Einzelposten.
Ergebnissatzspalten
Name Typ Beschreibung
OrderTotalAmount Double Gesamtbetrag der Bestellung.
Shipping Double Gesamtbetrag der Versandkosten für die Bestellung.
TaxableAmount Double Zu versteuernder Betrag der Bestellung.
AmountToCollect Double Zu erhebender Umsatzsteuerbetrag.
Rate Double Gesamtumsatzsteuersatz der Bestellung (zu erhebender Betrag ÷ steuerpflichtiger Betrag).
HasNexus Bool Ob Sie einen Nexus für die Bestellung basierend auf einer Adresse in der Datei, dem Nexus_Addresses-Parameter oder From_-Parametern haben oder nicht.
FreightTaxable Bool Frachtsteuerpflicht für die Bestellung.
TaxSource String Erhebung der Umsatzsteuer am Ursprungsort oder Bestimmungsort.
ExemptionType String Art der Befreiung für die Bestellung: Großhandel, Regierung, Marktplatz, Sonstiges oder nicht befreit. Wenn keine Kunden-ID oder Befreiungsart angegeben ist, wird in der Antwort auch keine Befreiungsart zurückgegeben.
JurisdictionAggregate String Gerichtsstandsbezeichnungen für die Anordnung.
BreakdownAggregate String Aufschlüsselung der Tarife nach Zuständigkeitsbereich für Bestellung, Versand und einzelne Positionen. Wenn has_nexus falsch ist oder keine Positionen angegeben sind, wird in der Antwort keine Aufschlüsselung zurückgegeben.

Steuersatz abrufen

Steuersätze für einen Standort abrufen.

Eingang
Name Typ Erforderlich Beschreibung
ZIP String True Postleitzahl für den angegebenen Ort (5-stellige ZIP oder ZIP+4).
Country String Falsch Zweistelliger ISO-Ländercode für den angegebenen Ort.
State String Falsch Zweistelliger ISO-Staatscode für den angegebenen Ort.
City String Falsch Stadt für angegebenen Standort.
Street String Falsch Straßenadresse für den angegebenen Standort.
Ergebnissatzspalten
Name Typ Beschreibung
ZIP String Ob die Umsatzsteuer-Identifikationsnummer per Regex und VIES gültig ist oder nicht.
Country String Land für angegebenen Standort, sofern SST-Status vorliegt.
CountryRate Double Landesweiter Umsatzsteuersatz für angegebenen Ort, sofern SST-Staat.
State String Postalisch abgekürzter Staatsname für den angegebenen Ort.
StateRate Double Staatlicher Umsatzsteuersatz für den angegebenen Standort.
County String Name des Landkreises für den angegebenen Ort.
CountyRate Double Umsatzsteuersatz des Landkreises für den angegebenen Ort.
City String Städtename für den angegebenen Standort.
CityRate Double Städtischer Umsatzsteuersatz für den angegebenen Ort.
CombinedDistrictRate Double Gesamtsteuersatz für alle am Standort gültigen Umsatzsteuerbezirke der Stadt und des Landkreises.
CombinedRate Double Gesamtumsatzsteuersatz, der die Steuern von Staat, Bezirk, Stadt und Landkreis umfasst. Dieser Satz sollte verwendet werden, um zu bestimmen, wie viel Umsatzsteuer für eine Bestellung erhoben werden soll.
FreightTaxable Bool Frachtsteuerpflicht für angegebenen Standort.
Name String Ländername für den angegebenen Standort.
StandardRate Double Standardtarif für den angegebenen Standort.
ReducedRate Double Ermäßigter Tarif für den angegebenen Standort.
SuperReducedRate Double Super ermäßigter Preis für angegebenen Standort.
ParkingRate Double Ermäßigter Parktarif für den angegebenen Standort.
DistanceSaleThreshold Double Fernabsatzschwelle für angegebenen Standort.

Adresse validieren

Validiert eine Kundenadresse und gibt eine Sammlung von Adressübereinstimmungen zurück.

Eingang
Name Typ Erforderlich Beschreibung
Country String Falsch Zweistelliger ISO-Ländercode der Kundenadresse.
State String Falsch Zweistelliger ISO-Staatscode der Kundenadresse.
ZIP String Falsch Postleitzahl für angegebenen Ort (5-stellige ZIP oder ZIP+4).
City String Falsch Stadt der Kundenadresse.
Street String Falsch Straßenadresse des Kunden oder die gesamte Adresse als Freiformeingabe.
Ergebnissatzspalten
Name Typ Beschreibung
AdressAggregates String Sammlung von Adressübereinstimmungen

ValidateVAT

Validiert eine vorhandene Umsatzsteuer-Identifikationsnummer

Eingang
Name Typ Erforderlich Beschreibung
VAT String True Zu validierende Umsatzsteuer-Identifikationsnummer. Der Ländercode muss vor der Nummer stehen, z. B. GB980780684.
Ergebnissatzspalten
Name Typ Beschreibung
Valid Bool Ob die Umsatzsteuer-Identifikationsnummer per Regex und VIES gültig ist oder nicht.
Exists Bool Ob die Umsatzsteuer-Identifikationsnummer im MIAS vorhanden ist oder nicht.
ViesAvailable Bool Ob VIES derzeit verfügbar ist oder nicht.
ViesResponseCountryCode String Von VIES zurückgegebener Ländercode basierend auf der angegebenen Umsatzsteuer-Identifikationsnummer.
ViesResponseVatNumber String Von VIES zurückgegebene Umsatzsteuer-Identifikationsnummer basierend auf der angegebenen Umsatzsteuer-Identifikationsnummer.
ViesResponseRequestDate Date Von VIES zurückgegebenes Anforderungsdatum basierend auf der angegebenen Umsatzsteuer-Identifikationsnummer.
ViesResponseValid Bool Ob die Umsatzsteuer-Identifikationsnummer gültig ist oder nicht, wird von VIES auf Grundlage der angegebenen Umsatzsteuer-Identifikationsnummer zurückgegeben.
ViesResponseName String Von VIES auf Grundlage der angegebenen Umsatzsteuer-Identifikationsnummer zurückgegebener Name.
ViesResponseAddress String Von VIES zurückgegebene Adresse basierend auf der angegebenen Umsatzsteuer-Identifikationsnummer.

Systemtabellen

Sie können die in diesem Abschnitt beschriebenen Systemtabellen Abfrage, um auf Schema, Informationen zur Datenquellenfunktionalität und Statistiken zu Operation Charge.

Schematabellen

Die folgenden Tabellen geben Datenbankmetadaten für TaxJar zurück:

Datenquellentabellen

Die folgenden Tabellen enthalten Informationen dazu, wie eine Verbindung zur Datenquelle hergestellt und diese Abfrage wird:

  • sys_connection_props: Gibt Informationen zu den verfügbaren Verbindungseigenschaften zurück.
  • sys_sqlinfo: Beschreibt die SELECT-Abfragen, die der Connector an die Datenquelle auslagern kann.

Abfrageinformationstabellen

Die folgende Tabelle gibt Abfrage für Datenänderungsabfragen zurück:

  • Systemidentität: Gibt Informationen zu Charge oder einzelnen Updates zurück.

Sys_catalogs

Listet die verfügbaren Datenbanken auf.

Die folgende Abfrage ruft alle durch die Verbindungszeichenfolge ermittelten Datenbanken ab:

SELECT * FROM sys_catalogs
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.

Sys_schemas

Listet die verfügbaren Schemas auf.

Die folgende Abfrage ruft alle verfügbaren Schemata ab:

SELECT * FROM sys_schemas
Spalten
Name Typ Beschreibung
CatalogName String Der Datenbankname.
SchemaName String Der Schema.

Sys_tables

Listet die verfügbaren Tabellen auf.

Die folgende Abfrage ruft die verfügbaren Tabellen und Ansichten ab:

SELECT * FROM sys_tables
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht.
TableType String Der Tabellentyp (Tabelle oder Ansicht).
Description String Eine Beschreibung der Tabelle oder Ansicht.
IsUpdateable Boolean Ob die Tabelle aktualisiert werden kann.

Sys_tablecolumns

Beschreibt die Spalten der verfügbaren Tabellen und Ansichten.

Die folgende Abfrage gibt die Spalten und Datentypen für die Tabelle „Orders“ zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Orders'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die Tabelle oder Ansicht enthält.
SchemaName String Das Schema, das die Tabelle oder Ansicht enthält.
TableName String Der Name der Tabelle oder Ansicht, die die Spalte enthält.
ColumnName String Der Spaltenname.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Speichergröße der Spalte.
DisplaySize Int32 Die normale Maximalbreite der angegebenen Spalte in Zeichen.
NumericPrecision Int32 Die maximale Anzahl von Ziffern in numerischen Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Spaltenskala oder Anzahl der Ziffern rechts vom Dezimalpunkt.
IsNullable Boolean Ob die Spalte Null enthalten kann.
Description String Eine kurze Beschreibung der Spalte.
Ordinal Int32 Die Sequenznummer der Spalte.
IsAutoIncrement String Ob der Spaltenwert in festen Schritten zugewiesen wird.
IsGeneratedColumn String Ob die Spalte generiert wird.
IsHidden Boolean Ob die Spalte ausgeblendet ist.
IsArray Boolean Ob die Spalte ein Array ist.
IsReadOnly Boolean Ob die Spalte schreibgeschützt ist.
IsKey Boolean Gibt an, ob ein von sys_tablecolumns zurückgegebenes Feld der Primärschlüssel der Tabelle ist.

Sys_procedures

Listet die verfügbaren gespeicherten Prozeduren auf.

Die folgende Abfrage ruft die verfügbaren gespeicherten Prozeduren ab:

SELECT * FROM sys_procedures
Spalten
Name Typ Beschreibung
CatalogName String Die Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Das Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur.
Description String Eine Beschreibung der gespeicherten Prozedur.
ProcedureType String Der Typ der Prozedur, z. B. PROZEDUR oder FUNKTION.

Sys_procedureparameters

Beschreibt Parameter gespeicherter Prozeduren.

Die folgende Abfrage gibt Informationen zu allen Eingabeparametern für die gespeicherte Prozedur ValidateVAT zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='ValidateVAT' AND Direction=1 OR Direction=2
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die die gespeicherte Prozedur enthält.
SchemaName String Der Name des Schema, das die gespeicherte Prozedur enthält.
ProcedureName String Der Name der gespeicherten Prozedur, die den Parameter enthält.
ColumnName String Der Name des gespeicherten Prozedurparameters.
Direction Int32 Eine Ganzzahl, die dem Typ des Parameters entspricht: Eingabe (1), Eingabe/Ausgabe (2) oder Ausgabe (4). Parameter vom Typ Eingabe/Ausgabe können sowohl Eingabe- als auch Ausgabeparameter sein.
DataTypeName String Der Name des Datentyps.
DataType Int32 Eine Ganzzahl, die den Datentyp angibt. Dieser Wert wird zur Laufzeit basierend auf der Umfeld bestimmt.
Length Int32 Die Anzahl der für Zeichendaten zulässigen Zeichen. Die Anzahl der für numerische Daten zulässigen Ziffern.
NumericPrecision Int32 Die maximale Genauigkeit für numerische Daten. Die Spaltenlänge in Zeichen für Zeichen- und Datums-/Uhrzeitdaten.
NumericScale Int32 Die Anzahl der Ziffern rechts vom Dezimalkomma in numerischen Daten.
IsNullable Boolean Ob der Parameter Null enthalten kann.
IsRequired Boolean Ob der Parameter zur Ausführung der Prozedur erforderlich ist.
IsArray Boolean Ob der Parameter ein Array ist.
Description String Die Beschreibung des Parameters.
Ordinal Int32 Der Index des Parameters.

Sys_keycolumns

Beschreibt die Primär- und Fremdschlüssel.

Die folgende Abfrage ruft den Primärschlüssel für die Tabelle „Orders“ ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Orders'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
IsKey Boolean Ob die Spalte ein Primärschlüssel in der Tabelle ist, auf die im Feld „TableName“ verwiesen wird.
IsForeignKey Boolean Ob die Spalte ein Fremdschlüssel ist, auf den im Feld TableName verwiesen wird.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.

Sys_foreignkeys

Beschreibt die Fremdschlüssel.

Die folgende Abfrage ruft alle Fremdschlüssel ab, die auf andere Tabellen verweisen:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
PrimaryKeyName String Der Name des Primärschlüssels.
ForeignKeyName String Der Name des Fremdschlüssels.
ReferencedCatalogName String Die Datenbank, die den Primärschlüssel enthält.
ReferencedSchemaName String Das Schema, das den Primärschlüssel enthält.
ReferencedTableName String Die Tabelle, die den Primärschlüssel enthält.
ReferencedColumnName String Der Spaltenname des Primärschlüssels.
ForeignKeyType String Gibt an, ob der Fremdschlüssel ein Importschlüssel (zeigt auf andere Tabellen) oder ein Exportschlüssel (referenziert von anderen Tabellen) ist.

Sys_primarykeys

Beschreibt die Primärschlüssel.

Die folgende Abfrage ruft die Primärschlüssel aus allen Tabellen und Ansichten ab:

SELECT * FROM sys_primarykeys
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Schlüssel enthält.
SchemaName String Der Name des Schema, das den Schlüssel enthält.
TableName String Der Name der Tabelle, die den Schlüssel enthält.
ColumnName String Der Name der Schlüsselspalte.
KeySeq String Die Sequenznummer des Primärschlüssels.
KeyName String Der Name des Primärschlüssels.

Sys_indexes

Beschreibt die verfügbaren Indizes. Durch das Filtern nach Indizes können Sie selektivere Abfragen mit schnelleren Abfrage schreiben.

Die folgende Abfrage ruft alle Indizes ab, die keine Primärschlüssel sind:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Spalten
Name Typ Beschreibung
CatalogName String Der Name der Datenbank, die den Index enthält.
SchemaName String Der Name des Schema, das den Index enthält.
TableName String Der Name der Tabelle, die den Index enthält.
IndexName String Der Indexname.
ColumnName String Der Name der mit dem Index verknüpften Spalte.
IsUnique Boolean Wahr, wenn der Index eindeutig ist. Andernfalls falsch.
IsPrimary Boolean Wahr, wenn der Index ein Primärschlüssel ist. Andernfalls falsch.
Type Int16 Ein ganzzahliger Wert, der dem Indextyp entspricht: Statistik (0), gruppiert (1), gehasht (2) oder Sonstiges (3).
SortOrder String Die Sortierreihenfolge: A für aufsteigend oder D für absteigend.
OrdinalPosition Int16 Die Sequenznummer der Spalte im Index.

Sys_connection_props

Gibt Informationen zu den verfügbaren Verbindungseigenschaften und den in der Verbindungszeichenfolge festgelegten Eigenschaften zurück.

Bei der Abfrage dieser Tabelle sollte die Konfigurationsverbindungszeichenfolge verwendet werden:

jdbc:cdata:taxjar:config:

Mit dieser Verbindungszeichenfolge können Sie diese Tabelle ohne eine gültige Verbindung Abfrage.

Die folgende Abfrage ruft alle Verbindungseigenschaften ab, die in der Verbindungszeichenfolge festgelegt oder über einen Standardwert gesetzt wurden:

SELECT * FROM sys_connection_props WHERE Value <> ''
Spalten
Name Typ Beschreibung
Name String Der Name der Verbindungseigenschaft.
ShortDescription String Eine kurze Beschreibung.
Type String Der Datentyp der Verbindungseigenschaft.
Default String Der Standardwert, sofern nicht explizit einer festgelegt wurde.
Values String Eine durch Kommas getrennte Liste möglicher Werte. Wenn ein anderer Wert angegeben wird, wird ein Validierungsfehler ausgegeben.
Value String Der von Ihnen festgelegte Wert oder ein vorkonfigurierter Standard.
Required Boolean Ob für die Immobilie eine Verbindung erforderlich ist.
Category String Die Kategorie der Verbindungseigenschaft.
IsSessionProperty String Ob die Eigenschaft eine Sitzungseigenschaft ist, die zum Speichern von Informationen zur aktuellen Verbindung verwendet wird.
Sensitivity String Die Vertraulichkeitsstufe der Eigenschaft. Diese gibt Aufschluss darüber, ob die Eigenschaft in Protokollierungs- und Authentifizierungsformularen verschleiert wird.
PropertyName String Eine verkürzte Form des Verbindungseigenschaftsnamens in Camel-Case-Schreibweise.
Ordinal Int32 Der Index des Parameters.
CatOrdinal Int32 Der Index der Parameterkategorie.
Hierarchy String Zeigt zugehörige abhängige Eigenschaften an, die zusammen mit dieser festgelegt werden müssen.
Visible Boolean Informiert, ob die Eigenschaft in der Verbindungs-Benutzeroberfläche sichtbar ist.
ETC String Diverse sonstige Informationen zum Objekt.

Sys_sqlinfo

Beschreibt die SELECT- Abfrage, die der Connector an die Datenquelle auslagern kann.

Entdecken der SELECT-Funktionen der Datenquelle

Nachfolgend sehen Sie einen Beispieldatensatz mit SQL-Funktionen. Einige Aspekte der SELECT-Funktionalität werden in einer durch Kommas getrennten Liste zurückgegeben, sofern sie unterstützt werden. Andernfalls enthält die Spalte NO.

Name Beschreibung Mögliche Werte
AGGREGATE_FUNCTIONS Unterstützte Aggregatfunktionen. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Ob die COUNT-Funktion unterstützt wird. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR Das öffnende Zeichen, das zum Escapen eines Bezeichners verwendet wird. [
IDENTIFIER_QUOTE_CLOSE_CHAR Das abschließende Zeichen, das zum Escapen eines Bezeichners verwendet wird. ]
SUPPORTED_OPERATORS Eine Liste unterstützter SQL-Operatoren. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Ob GROUP BY unterstützt wird und wenn ja, in welchem Umfang. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Unterstützte String-Funktionen. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Unterstützte numerische Funktionen. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Unterstützte Datums-/Uhrzeitfunktionen. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Zeigt an, dass während der Replikation Tabellen übersprungen wurden.
REPLICATION_TIMECHECK_COLUMNS Ein Zeichenfolgenarray mit einer Liste von Spalten, die (in der angegebenen Reihenfolge) zur Überprüfung verwendet werden, ob sie während der Replikation als geänderte Spalte verwendet werden sollen.
IDENTIFIER_PATTERN Zeichenfolgenwert, der angibt, welche Zeichenfolge für einen Bezeichner gültig ist.
SUPPORT_TRANSACTION Gibt an, ob der Anbieter Transaktionen wie Commit und Rollback unterstützt. YES, NO
DIALECT Gibt den zu verwendenden SQL-Dialekt an.
KEY_PROPERTIES Gibt die Eigenschaften an, die die einheitliche Datenbank identifizieren.
SUPPORTS_MULTIPLE_SCHEMAS Gibt an, ob für den Anbieter mehrere Schemas vorhanden sein können. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Gibt an, ob für den Anbieter mehrere Kataloge vorhanden sein können. YES, NO
DATASYNCVERSION Die für den Zugriff auf diesen Treiber erforderliche Data Sync-Version. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY Die Kategorie „Datensynchronisierung“ dieses Treiber. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Ob erweiterte SQL-Funktionen über das hinaus, was die API bietet, unterstützt werden. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Ob Charge Operationen unterstützt werden. YES, NO
SQL_CAP Alle unterstützten SQL-Funktionen für diesen Treiber. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS Ein Zeichenfolgenwert gibt die bevorzugten Cacheoptionen an.
ENABLE_EF_ADVANCED_QUERY Gibt an, ob der Treiber erweiterte Abfragen aus dem Entity Framework direkt unterstützt. Wenn nicht, werden die Abfragen clientseitig verarbeitet. YES, NO
PSEUDO_COLUMNS Ein Zeichenfolgenarray, das die verfügbaren Pseudospalten angibt.
MERGE_ALWAYS Wenn der Wert „true“ ist, wird der Merge-Modus in der Datensynchronisierung zwangsweise ausgeführt. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY Eine Abfrage zum Zurückgeben des Startdatums und der Startzeit der Replikation.
REPLICATION_MIN_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zum Ausführen eines serverseitigen Minimums verwendet werden soll.
REPLICATION_START_DATE Ermöglicht einem Anbieter, ein Replikationsstartdatum anzugeben.
REPLICATION_MAX_DATE_QUERY Eine Abfrage zum Zurückgeben des Enddatums und der Endzeit der Replikation.
REPLICATION_MAX_FUNCTION Ermöglicht einem Anbieter, den Formelnamen anzugeben, der zur Ausführung eines serverseitigen Max. verwendet werden soll.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE Eine Liste von Tabellen, bei denen das Aufteilen der Replikation in Blöcke bei der ersten Replikation übersprungen wird.
CHECKCACHE_USE_PARENTID Gibt an, ob die CheckCache-Anweisung für die übergeordnete Schlüsselspalte ausgeführt werden soll. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Gibt gespeicherte Prozeduren an, die zum Generieren von Schema verwendet werden können.

Die folgende Abfrage ruft die Operatoren ab, die in der WHERE-Klausel verwendet werden können:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Beachten Sie, dass einzelne Tabellen unterschiedliche Einschränkungen oder Anforderungen an die WHERE-Klausel haben können; siehe Datenmodell Abschnitt für weitere Informationen.

Spalten
Name Typ Beschreibung
NAME String Eine Komponente der SQL-Syntax oder eine Funktion, die auf dem Server verarbeitet werden kann.
VALUE String Details zum unterstützten SQL bzw. zur SQL-Syntax.

Systemidentität

Gibt Informationen zu versuchten Änderungen zurück.

Die folgende Abfrage ruft die IDs der geänderten Zeilen in einer Operation Charge:

SELECT * FROM sys_identity
Spalten
Name Typ Beschreibung
Id String Die von einer Operation zurückgegebene, von der Datenbank generierte ID.
Batch String Eine Kennung für den Charge. 1 für einen einzelnen Operation.
Operation String Das Ergebnis der Operation im Charge: EINGEFÜGT, AKTUALISIERT oder GELÖSCHT.
Message String SUCCESS oder eine Fehlermeldung, wenn das Update im Charge fehlgeschlagen ist.

Systeminformationen

Beschreibt die verfügbaren Systeminformationen.

Die folgende Abfrage ruft alle Spalten ab:

SELECT * FROM sys_information
Spalten
Name Typ Beschreibung
Product String Der Name des Produkts.
Version String Die Versionsnummer des Produkts.
Datasource String Der Name der Datenquelle, mit der das Produkt eine Verbindung herstellt.
NodeId String Die eindeutige Kennung der Maschine, auf der das Produkt installiert ist.
HelpURL String Die URL zur Hilfedokumentation des Produkts.
License String Die Lizenzinformationen für das Produkt. (Wenn diese Informationen nicht verfügbar sind, kann das Feld leer gelassen oder als „N/A“ markiert werden.)
Location String Der Dateipfad, in dem die Produktbibliothek gespeichert ist.
Environment String Die Version der Umfeld oder Rumtine, unter der das Produkt derzeit ausgeführt wird.
DataSyncVersion String Die zur Verwendung dieses Connectors erforderliche Synchronisierungsebene.
DataSyncCategory String Die Kategorie der Synchronisierungsfunktionalität (z. B. Quelle, Ziel).

Erweiterte Konfigurationseigenschaften

Die erweiterten Konfigurationseigenschaften sind die verschiedenen Optionen, die zum Herstellen einer Verbindung verwendet werden können. Dieser Abschnitt enthält eine vollständige Liste der Optionen, die Sie konfigurieren können. Klicken Sie auf die Links, um weitere Einzelheiten zu erfahren.

Authentifizierung

Eigenschaft Beschreibung
APIKey Der von der TaxJar Benutzeroberfläche abgerufene API-Schlüssel.
UseSandbox Ob eine Verbindung zur Sandbox Umfeld hergestellt werden soll oder nicht.

SSL

Eigenschaft Beschreibung
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

Schema

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.

Verschiedenes

Eigenschaft Beschreibung
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
MaxThreads Gibt die Anzahl gleichzeitiger Anfragen an.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Andere

Eigenschaft Beschreibung
StartDate Bestimmt das Startdatum der Transaktionsbestellungen/Rückerstattungen.

Authentifizierung

Dieser Abschnitt enthält eine vollständige Liste der Authentifizierungseigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
APIKey Der von der TaxJar Benutzeroberfläche abgerufene API-Schlüssel.
UseSandbox Ob eine Verbindung zur Sandbox Umfeld hergestellt werden soll oder nicht.

APISchlüssel

Der von der TaxJar Benutzeroberfläche abgerufene API-Schlüssel.

Datentyp

string

Standardwert

""

Hinweise

Wenn Sie bereits über einen Professional- oder Premium-Plan verfügen, finden Sie den API Schlüssel, indem Sie sich bei der TaxJar Benutzeroberfläche anmelden und zu „Konto“ -> „TaxJar API“ navigieren.

Sandbox verwenden

Ob eine Verbindung zur Sandbox Umfeld hergestellt werden soll oder nicht.

Datentyp

bool

Standardwert

false

Hinweise

Setzen Sie dies auf true, um eine Verbindung zur TaxJar Sandbox Umfeld herzustellen. Denken Sie daran, dass der APIKey muss auch für die Sandbox Umfeld generiert werden.

SSL

Dieser Abschnitt enthält eine vollständige Liste der SSL-Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
SSLServerCert Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

SSLServerCert

Das vom Server zu akzeptierende Zertifikat bei einer Verbindung per TLS/SSL.

Datentyp

string

Standardwert

""

Hinweise

Bei Verwendung einer TLS/SSL-Verbindung kann diese Eigenschaft verwendet werden, um das vom Server zu akzeptierende TLS/SSL-Zertifikat anzugeben. Jedes andere Zertifikat, dem der Computer nicht vertraut, wird abgelehnt.

Diese Eigenschaft kann folgende Formen annehmen:

Beschreibung Beispiel
Ein vollständiges PEM-Zertifikat (Beispiel der Kürze halber gekürzt) -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
Ein Pfad zu einer lokalen Datei, die das Zertifikat enthält C:\\cert.cer
Der öffentliche Schlüssel (Beispiel der Kürze halber gekürzt) -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
Der MD5-Fingerabdruck (Hexadezimalwerte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) ecadbdda5a1529c58a1e9e09828d70e4
Der SHA1-Fingerabdruck (Hex-Werte können auch durch Leerzeichen oder Doppelpunkte getrennt sein) 34a929226ae0819f2ec14b4a3d904f801cbb150d

Wenn nicht angegeben, wird jedes vom Computer vertrauenswürdige Zertifikat akzeptiert.

Zertifikate werden vom Computer basierend auf dem Trust Store des Systems als vertrauenswürdig validiert. Der verwendete Trust Store ist der für das System angegebene Wert „javax.net.ssl.trustStore“. Wenn für diese Eigenschaft kein Wert angegeben ist, wird der Standard-Trust Store von Java verwendet (z. B. JAVA_HOME\lib\security\cacerts).

Verwenden Sie „*“, um anzugeben, dass alle Zertifikate akzeptiert werden. Beachten Sie, dass dies aus Sicherheitsgründen nicht empfohlen wird.

Schema

Dieser Abschnitt enthält eine vollständige Liste der Schema, die Sie konfigurieren können.

Eigenschaft Beschreibung
Location Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.
BrowsableSchemas Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA, TabelleB, TabelleC.
Views Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA, AnsichtB, AnsichtC.

Standort

Ein Pfad zum Verzeichnis, das die Schema enthält, die Tabellen, Ansichten und gespeicherte Prozeduren definieren.

Datentyp

string

Standardwert

%APPDATA%\TaxJar Data Provider\Schema

Hinweise

Der Pfad zu einem Verzeichnis, das die Schema für den Connector enthält (.rsd-Dateien für Tabellen und Ansichten, .rsb-Dateien für gespeicherte Prozeduren). Der Ordnerspeicherort kann ein relativer Pfad vom Speicherort der ausführbaren Datei sein. Der Location Die Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.

Wenn nichts angegeben wird, ist der Standardspeicherort "%APPDATA%\ TaxJar Data Provider\Schema" mit %APPDATA% wird auf das Konfigurationsverzeichnis des Benutzers eingestellt:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Mac ~/Bibliothek/Anwendungsunterstützung
Linux ~/.config

DurchsuchbareSchemas

Diese Eigenschaft beschränkt die gemeldeten Schemata auf eine Teilmenge der verfügbaren Schemata. Beispiel: BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Schemata aus Datenbanken kann aufwändig sein. Die Bereitstellung einer Liste von Schemata in der Verbindungszeichenfolge verbessert die Leistung.

Tabellen

Diese Eigenschaft beschränkt die gemeldeten Tabellen auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Tabellen=TabelleA,TabelleB,TabelleC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Tabellen aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Tabellen in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Tabellen in einer durch Kommas getrennten Liste an. Jede Tabelle sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Ansichten

Beschränkt die gemeldeten Ansichten auf eine Teilmenge der verfügbaren Tabellen. Beispiel: Ansichten=AnsichtA,AnsichtB,AnsichtC.

Datentyp

string

Standardwert

""

Hinweise

Das Auflisten der Ansichten aus einigen Datenbanken kann teuer sein. Die Bereitstellung einer Liste von Ansichten in der Verbindungszeichenfolge verbessert die Leistung des Connectors.

Diese Eigenschaft kann auch als Alternative zum automatischen Auflisten von Ansichten verwendet werden, wenn Sie bereits wissen, mit welchen Sie arbeiten möchten, und es sonst zu viele wären.

Geben Sie die gewünschten Ansichten in einer durch Kommas getrennten Liste an. Jede Ansicht sollte ein gültiger SQL-Bezeichner sein, wobei alle Sonderzeichen mit eckigen Klammern, Anführungszeichen oder Backticks maskiert werden. Beispiel: Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Beachten Sie, dass Sie beim Herstellen einer Verbindung zu einer Datenquelle mit mehreren Schemata oder Katalogen den vollqualifizierten Namen der Tabelle in dieser Eigenschaft angeben müssen, wie im letzten Beispiel hier, um Mehrdeutigkeiten zwischen Tabellen zu vermeiden, die in mehreren Katalogen oder Schemata vorhanden sind.

Verschiedenes

Dieser Abschnitt enthält eine vollständige Liste verschiedener Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
MaxRows Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.
MaxThreads Gibt die Anzahl gleichzeitiger Anfragen an.
Other Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.
PseudoColumns Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.
Timeout Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.
UserDefinedViews Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

MaxRows

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

Datentyp

int

Standardwert

-1

Hinweise

Begrenzt die Anzahl der zurückgegebenen Zeilen, wenn in der Abfrage keine Aggregation oder GROUP BY verwendet wird. Dies hat Vorrang vor LIMIT-Klauseln.

MaxThreads

Gibt die Anzahl gleichzeitiger Anfragen an.

Datentyp

string

Standardwert

20

Hinweise

Mit dieser Eigenschaft können Sie mehrere Anfragen gleichzeitig stellen und so die Leistung verbessern.

Die TaxJar API hat eine Ratenbegrenzung von 10.000 Anfragen pro Minute für TaxJar Professional-Pläne und 25.000 Anfragen pro Minute für die TaxJar Premium-Pläne.

Aufgrund der Beschränkungen der TaxJar API kann der Connector nur für jede Zeile eine HTTP-Anfrage stellen, um möglichst viele Daten zu erfassen.

Um die Leistung des Connectors zu verbessern, können Sie diesen Wert basierend auf den Ressourcen des Computers erhöhen.

Andere

Diese versteckten Eigenschaften werden nur in bestimmten Anwendungsfällen verwendet.

Datentyp

string

Standardwert

""

Hinweise

Die unten aufgeführten Eigenschaften sind für bestimmte Anwendungsfälle verfügbar. Für normale Anwendungsfälle und Funktionen von Treiber sollten diese Eigenschaften nicht erforderlich sein.

Geben Sie mehrere Eigenschaften in einer durch Semikolon getrennten Liste an.

Integration und Formatierung
Eigenschaft Beschreibung
DefaultColumnSize Legt die Standardlänge von Zeichenfolgefeldern fest, wenn die Datenquelle keine Spaltenlänge in den Metadaten bereitstellt. Der Standardwert ist 2000.
ConvertDateTimeToGMT Bestimmt, ob Datums-/Uhrzeitwerte in GMT statt in die lokale Zeit des Computers konvertiert werden sollen.
RecordToFile=filename Protokolliert den zugrunde liegenden Socket-Datenübertragungsvorgang in die angegebene Datei.

Pseudospalten

Diese Eigenschaft gibt an, ob Pseudospalten als Spalten in die Tabelle aufgenommen werden sollen oder nicht.

Datentyp

string

Standardwert

""

Hinweise

Diese Einstellung ist besonders hilfreich im Entity Framework, da Sie dort keinen Wert für eine Pseudospalte festlegen können, es sei denn, es handelt sich um eine Tabellenspalte. Der Wert dieser Verbindungseinstellung hat das Format „Tabelle1=Spalte1, Tabelle1=Spalte2, Tabelle2=Spalte3“. Sie können das Zeichen „*“ verwenden, um alle Tabellen und alle Spalten einzuschließen, z. B. „*=*“.

Zeitüberschreitung

Der Wert in Sekunden, bis der Timeout-Fehler auftritt und der Operation abgebrochen wird.

Datentyp

int

Standardwert

60

Hinweise

Wenn Timeout = 0, Operationen werden nicht abgebrochen. Die Operationen werden ausgeführt, bis sie erfolgreich abgeschlossen sind oder bis ein Fehler auftritt.

Wenn Timeout abläuft und der Operation noch nicht abgeschlossen ist, löst der Connector eine Ausnahme aus.

BenutzerdefinierteAnsichten

Ein Dateipfad, der auf die JSON-Konfigurationsdatei verweist, die Ihre benutzerdefinierten Ansichten enthält.

Datentyp

string

Standardwert

""

Hinweise

Benutzerdefinierte Ansichten werden in einer JSON-formatierten Konfigurationsdatei namens UserDefinedViews.json. Der Connector erkennt die in dieser Datei angegebenen Ansichten automatisch.

Sie können auch mehrere Ansichtsdefinitionen haben und diese mit steuern UserDefinedViews Verbindungseigenschaft. Wenn Sie diese Eigenschaft verwenden, werden vom Connector nur die angegebenen Ansichten angezeigt.

Diese Konfigurationsdatei für benutzerdefinierte Ansichten ist wie folgt formatiert:

  • Jedes Stammelement definiert den Namen einer Ansicht.
  • Jedes Stammelement enthält ein untergeordnetes Element namens query, das die benutzerdefinierte SQL- Abfrage für die Ansicht enthält.

Zum Beispiel:

{
    "MyView": {
        "query": "SELECT * FROM Orders WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Verwenden Sie die UserDefinedViews Verbindungseigenschaft, um den Speicherort Ihrer JSON-Konfigurationsdatei anzugeben. Beispiel:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Beachten Sie, dass der angegebene Pfad nicht in Anführungszeichen steht.

Andere

Dieser Abschnitt enthält eine vollständige Liste der anderen Eigenschaften, die Sie konfigurieren können.

Eigenschaft Beschreibung
StartDate Bestimmt das Startdatum der Transaktionsbestellungen/Rückerstattungen.

Startdatum

Bestimmt das Startdatum der Transaktionsbestellungen/Rückerstattungen.

Datentyp

string

Standardwert

""

Hinweise

Standardmäßig werden von der API Bestellungen oder Rückerstattungen der letzten 3 Monate abgerufen. Um diesen Bereich zu ändern, legen Sie diese Verbindungseigenschaft bitte auf ein gewünschtes Datum im Format JJJJ/MM/TT fest.