Zum Inhalt springen

Xero-Verbindungsdetails

Einführung

Connector-Version

Diese Dokumentation basiert auf Version 23.0.8852 des Connectors.

Erste Schritte

Xero-Versionsunterstützung

Der Xero Connector modelliert Xero Accounting-, Australian Payroll-, Files-, Assets- und Projects-Objekte als relationale Datenbank.

Herstellen einer Verbindung

Mit Xero verbinden

Der Connector unterstützt die Verwendung von PKCE-Anwendungen und OAuth-Anwendungen. Sowohl PKCE- als auch OAuth-Verbindungen zu Xero werden mit OAuth authentifiziert. Wenn der Connector startet, öffnet er einen Browser und fordert Ihre Anmeldeinformationen an. Der Connector verwendet die von Ihnen angegebenen Anmeldeinformationen, um auf Ihre Xero Daten zuzugreifen. Diese Anmeldeinformationen werden gespeichert und bei Bedarf automatisch aktualisiert.

Um diese Authentifizierung für alle OAuth-Flows zu aktivieren, müssen Sie festlegen AuthScheme Zu OAuth, und Sie müssen eine benutzerdefinierte OAuth-Anwendung erstellen.

In den folgenden Unterabschnitten wird die Authentifizierung bei Xero über drei gängige Authentifizierungsabläufe beschrieben:

  • Desktop: eine Verbindung zu einem Server auf dem lokalen Rechner des Benutzers, die häufig zum Testen und Prototyping verwendet wird.
  • Web: Zugriff auf Daten über eine gemeinsam genutzte Website.
  • Headless Server: ein dedizierter Computer, der Dienste für andere Computer und deren Benutzer bereitstellt und so konfiguriert ist, dass er ohne Monitor und Tastatur funktioniert.

Informationen zum Erstellen einer benutzerdefinierten OAuth-Anwendung finden Sie unter Erstellen einer benutzerdefinierten Authentifizierungsanwendung.

Eine vollständige Liste der in Xero verfügbaren Verbindungszeichenfolgeneigenschaften finden Sie unter Connection.

Desktop-Anwendungen

Um sich mit den Anmeldeinformationen für eine benutzerdefinierte OAuth-Anwendung zu authentifizieren, müssen Sie das OAuth-Zugriffstoken abrufen und aktualisieren. Danach können Sie eine Verbindung herstellen.

OAuth-Zugriffstoken abrufen und aktualisieren:

  • InitiateOAuth = GETANDREFRESH. Wird verwendet, um automatisch die abzurufen und zu aktualisieren OAuthAccessToken.
  • OAuthClientId = die Client-ID, die Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
  • OAuthClientSecret = das Client-Geheimnis, das Ihnen bei der Registrierung Ihrer Anwendung zugewiesen wurde.
  • CallbackURL = die Umleitungs-URI, die bei der Registrierung Ihrer Anwendung definiert wurde.

Wenn Sie eine Verbindung herstellen, öffnet der Connector den OAuth-Endpoint von Xero in Ihrem Standardbrowser. Melden Sie sich an und erteilen Sie der Anwendung Berechtigungen.

Nachdem Sie der Anwendung Berechtigungen erteilt haben, schließt der Connector den OAuth-Prozess ab:

  1. Der Connector erhält einen Zugriffstoken von Xero und verwendet ihn, um Daten anzufordern.
  2. Die OAuth-Werte werden im in angegebenen Pfad gespeichert OAuthSettingsLocation. Diese Werte bleiben über Verbindungen hinweg bestehen.

Wenn das Zugriffstoken abläuft, aktualisiert der Connector es automatisch.

Automatische Aktualisierung des OAuth-Zugriffstokens:

Damit der Connector das OAuth-Zugriffstoken automatisch aktualisiert, gehen Sie wie folgt vor:

  1. Legen Sie vor der ersten Verbindung mit Daten die folgenden Verbindungsparameter fest:
    • InitiateOAuth = REFRESH.
    • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
    • OAuthClientSecret = das Client-Geheimnis in Ihren Anwendungseinstellungen.
    • OAuthAccessToken = der von GetOAuthAccessToken zurückgegebene Zugriffstoken.
    • OAuthSettingsLocation = der Pfad, in dem der Connector die OAuth-Werte speichern soll, die über Verbindungen hinweg bestehen bleiben.
  2. Legen Sie bei nachfolgenden Datenverbindungen Folgendes fest:
    • InitiateOAuth
    • OAuthSettingsLocation

Manuelle Aktualisierung des OAuth-Zugriffstokens:

Der einzige Wert, der zur manuellen Aktualisierung des OAuth-Zugriffstokens benötigt wird, ist das OAuth-Aktualisierungstoken.

  1. Um das OAuthAccessToken nach dem ExpiresIn-Zeitraum (zurückgegeben von GetOAuthAccessToken manuell zu aktualisieren) abgelaufen ist, rufen Sie den GetOAuthAccessToken gespeicherte Prozedur.
  2. Legen Sie die folgenden Verbindungseigenschaften fest:
    • OAuthClientId = die Client-ID in Ihren Anwendungseinstellungen.
    • OAuthClientSecret = das Client Secret in Ihren Anwendungseinstellungen.
  3. Rufen Sie GetOAuthAccessToken auf mit OAuthRefreshToken auf das von GetOAuthAccessToken zurückgegebene OAuth-Aktualisierungstoken gesetzt.
  4. Nachdem die neuen Token abgerufen wurden, setzen Sie das OAuthAccessTokenEigenschaft auf den von GetOAuthAccessToken zurückgegebenen Wert. Dadurch wird eine neue Verbindung geöffnet.

Speichern Sie das OAuth-Aktualisierungstoken, damit Sie es verwenden können, um das OAuth-Zugriffstoken nach Ablauf manuell zu aktualisieren.

Herstellen einer Verbindung zu einer Xero API

Der Connector unterstützt mehrere Xero APIs. Um eine Verbindung mit ihnen herzustellen, legen Sie die entsprechende Verbindungseigenschaft fest:

  • Für die Accounting API setzen Sie Schema Zu ACCOUNTING.
  • Für die Australian Payroll API setzen Sie Schema Zu PAYROLLAUS.
  • Für die Files API setzen Sie Schema Zu FILES.
  • Für das API Set für Anlagevermögen Schema Zu ASSETS.
  • Für die Projekte API setzen Sie Schema Zu PROJECTS.

Angeben des zulässigen Organisationszugriffs

Für alle oben genannten APIs empfehlen wir außerdem die Einstellung Tenant Eigenschaft, mit der Sie dem Connector den Zugriff auf mehrere Organisationen autorisieren können. Tenant wird normalerweise gesetzt, um eine oder mehrere Organisationen zu identifizieren, auf die der Connector zugreifen kann. Rechtliche Einträge für Tenant kann entweder der Name der Organisation oder ihre ID sein. (Da mehrere Organisationen den gleichen Namen haben können, empfehlen wir, die ID zu verwenden, um die Tenant Eigentum.)

Erstellen einer benutzerdefinierten Authentifizierungsanwendung

Erstellen einer benutzerdefinierten Authentifizierungsanwendung

In diesem Abschnitt wird beschrieben, wie Sie benutzerdefinierte Authentifizierungsanwendungen für die Verwendung mit PKCE, OAuth und benutzerdefinierten Verbindungen erstellen. Entwickler, die clientseitige Anwendungen schreiben, können PKCE verwenden, um Anwendungen lokal zu testen, da PKCE kein Client-Geheimnis erfordert.

OAuth

So erstellen und registrieren Sie eine OAuth-Anwendung für Desktop-, Web- oder Headless-Server und erhalten die OAuthClientId Und OAuthClientSecret:

  1. Melden Sie sich beim Xero Entwickler an.
  2. Navigieren Sie zu My Apps > Add Application.
  3. Wählen Sie den Anwendungstyp Auth Code.
  4. Geben Sie einen Namen für Ihre Anwendung und die URL Ihres Unternehmens ein. Diese Informationen werden den Benutzern angezeigt, wenn sie eine Verbindung herstellen.
  5. Fügen Sie eine Umleitungs-URI hinzu. Die gleiche URI sollte in festgelegt werden CallbackURL.
  6. Klicken Sie auf Save. Xero zeigt die OAuth-Client-ID der neuen Anwendung an.
  7. Erstellen Sie ein neues OAuth-Client-Geheimnis.
  8. Satz OAuthClientId Und OAuthClientSecret zu den Anmeldeinformationen, die Sie gerade erhalten haben.

Benutzerdefinierte Verbindungen

Xero unterstützt auch Server-zu-Server-OAuth-Integrationen mithilfe von benutzerdefinierten Verbindungen. Lizenzen für diese Verbindungen müssen von Xero erworben werden, bevor sie in Produktionsorganisationen verwendet werden können. Sie können auch kostenlos mit Demoorganisationen verknüpft werden.

So registrieren Sie eine benutzerdefinierte Verbindungsanwendung in Xero:

  1. Melden Sie sich beim Xero Entwickler an.

  2. Navigieren Sie zu My Apps > Add Application.

  3. Geben Sie einen Anwendungstyp von an Custom Connection.

  4. Wählen Sie eine Liste der Bereiche aus, auf die diese Anwendung Zugriff haben soll. Um Berechtigungskonflikte beim Verbinden des Connectors zu vermeiden, empfehlen wir

, dass Sie alle verfügbaren Bereiche auswählen. Sie können Bereiche auch einzeln auswählen, aber wenn Sie dies tun, müssen Sie die aktualisieren Scope Verbindungseigenschaft, die übereinstimmen soll.

  1. Wählen Sie bei Bedarf einen Benutzer aus, der die Verbindung autorisiert. Wenn Sie dies tun, kann die Anwendung nur mit einer Organisation verknüpft werden, auf die dieser Benutzer zugreifen kann.

  2. Klicken Sie auf Save and Connect. Xero sendet eine Email an den von Ihnen ausgewählten Benutzer, die Anweisungen zum Verknüpfen der Anwendung mit einer Organisation enthält.

  3. Warten Sie, bis der Benutzer die Anwendung verknüpft.

  4. Kehren Sie zum Entwickler zurück und öffnen Sie die Anwendungseinstellungen.

  5. Klicken Sie auf die Tab Konfiguration und scrollen Sie zu Client Id. Die Client-ID wird verwendet, um die OAuthClientId Anwendungseigenschaft.

  6. Klicken Sie auf Generate a Secret.

  7. Kopieren Sie das gerade generierte Geheimnis und wenden Sie es auf an OAuthClientSecret Eigentum.

Xero API Grenzen

Xero API Grenzen

Die Xero API hat Nutzungsbeschränkungen, die bei der Verwendung des Xero Connectors auftreten können. Beachten Sie, dass alle diese Einschränkungen pro Anwendung und Organisation gelten. Eine Anwendung kann diese Beschränkungen überschreiten, wenn sie mehrere Organisationen abfragt, solange sie die Beschränkungen innerhalb jeder Organisation einhält.

Gleichzeitigkeitslimit

Es dürfen maximal 5 API Aufrufe von der Anwendung gleichzeitig für dieselbe Organisation aktiv sein. Normalerweise stellt diese Beschränkung kein Problem dar, da der Connector in diesem Fall die aktuelle Anfrage automatisch wiederholt.

Minutenlimit

Von der Anwendung aus dürfen maximal 60 API Aufrufe pro Minute an dieselbe Organisation erfolgen. Auch diese Grenze stellt kein Problem dar, da Xero eine empfohlene Verzögerungszeit meldet, die der Connector verwendet, um ein erneutes Erreichen der Grenze zu vermeiden.

Begrenzung nicht zertifizierter Steckverbinder

Nicht zertifizierte OAuth-Anwendungen sind auf 25 Verbindungen beschränkt. Für zertifizierte Apps gibt es keine Verbindungsbeschränkung.

Tageslimit

Von der Anwendung aus dürfen maximal 5000 API Aufrufe pro Tag an dieselbe Organisation erfolgen. Das Erreichen dieses Grenzwertes ist selten, kann aber bei bestimmten Tabellen (z. B. Verlaufstabellen und einigen Berichten) oder bestimmten Einstellungen (z. B. vorkommen AutoExpandDetails) werden verwendet, da sie erfordern, dass der Connector für jede gelesene Rechnung/jeden gelesenen Kontakt/usw. einen einzelnen API Aufruf tätigt.

Wenn dieses Limit häufig erreicht wird, sollten Sie zunächst die Tabellen oder Einstellungen vermeiden, die es auslösen. Es ist auch möglich, die Abfragen in Versionen umzuwandeln, die weniger Zeilen auf einmal lesen. Dies geschieht normalerweise, indem einfache Auswahlen durch Unterabfragen ersetzt werden, die kleine Zeilengruppen auswählen, und dann mehrere Versionen dieser Abfragen zu unterschiedlichen Zeitpunkten verwendet werden:

/* Retreives history for about 1/16 of the invoices */
SELECT * FROM HistoryInvoices WHERE InvoiceId IN (
  SELECT InvoiceId FROM Invoices WHERE InvoiceId LIKE '0%'
)

Die RetryDailyLimit Die Option ist ebenfalls verfügbar, von ihrer Verwendung wird jedoch dringend abgeraten, da die von Xero vorgeschlagenen Verzögerungen im schlimmsten Fall mehrere Stunden betragen können, während derer der Connector nicht verfügbar ist. Normalerweise ist es besser, die Art und Weise, wie Sie Daten anfordern, so umzustrukturieren, dass sie innerhalb der Grenzen liegen, als die Grenzen zu ignorieren und Abfragen auszuführen, deren Ausführung mehrere Stunden dauert.

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 Xero-Connectors 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 Xero und verarbeitet dann den Rest der Abfrage im Speicher (clientseitig).

Siehe Abfrageverarbeitung für weitere Informationen.

Benutzerdefinierte Ansichten

Mit dem Xero-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 Contacts 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

Der Xero Connector modelliert fünf Xero APIs als relationale Datenbanken: die APIs für Buchhaltung, australische Gehaltsabrechnung, Dateien, Anlagevermögen und Projekte. Setzen Sie die Schema Eigenschaft und verwenden Sie die Informationen in jedem Abschnitt, um basierend auf den Anforderungen Ihres Projekts die richtige API auszuwählen.

Verwenden der Accounting-API

Die Accounting API enthält die Finanzinformationen des Unternehmens, wie z. B. Kontakte, Rechnungen und Berichte. Sie enthält außerdem Verlaufstabellen, in denen Änderungen an den meisten Entitätsarten aufgezeichnet werden.

INSERTs in bestimmte Tabellen, deren Modellpositionen in der Accounting API Charge Unterstützung aktiviert haben. Die empfohlene Einstellung von BatchSize für maximale Leistung ist 50.

Siehe Buchhaltungsdatenmodell für die verfügbaren Entitäten in der Accounting API.

Verwendung der australischen Gehaltsabrechnungs API

Die Australian Payroll API enthält Informationen zu den Mitarbeitern des Unternehmens, wie etwa Arbeitszeitnachweise, Urlaubs- und Steuererklärungen.

INSERTs in bestimmte Tabellen, deren Modellpositionen in der Australian Payroll API Charge Unterstützung aktiviert haben. Die empfohlene Einstellung von BatchSize für maximale Leistung ist 50.

Siehe Australisches Gehaltsdatenmodell für die verfügbaren Entitäten in der Australian Payroll API.

Verwenden der Datei API

Die Files API enthält Informationen zu den von Xero verwalteten Dateien und Anhängen. Sie kann zum Hoch- und Herunterladen von Dateien sowie zum Anhängen an Buchhaltungseinheiten verwendet werden.

Siehe Files-Datenmodell für die verfügbaren Entitäten in der Files API.

Verwenden der API für Anlagevermögen

Die API für Anlagevermögen enthält Informationen zum Anlagevermögen des Unternehmens, beispielsweise Registrierung, Abschreibung und Wiederverkauf.

Siehe Datenmodell für Anlagevermögen für die verfügbaren Entitäten in der API für Anlagevermögen.

Verwenden der Projekt API

Die Projekte API enthält Informationen zu den Projekten des Unternehmens, beispielsweise zur Abrechnung und Zeiterfassung.

Siehe Projektdatenmodell für die verfügbaren Entitäten in der Projekte API.

Buchhaltungsdatenmodell

Der Xero-Connector modelliert die Xero Accounting API als relationale Tabellen, Ansichten und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen sind in diesem Abschnitt dokumentiert. Sie können die SupportEnhancedSQL Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Ansichten

Ansichten sind Tabellen, die nicht geändert werden können. Normalerweise werden Daten, die schreibgeschützt sind und nicht aktualisiert werden können, als Ansichten angezeigt.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen

in der Datenquelle verwendet werden.

Tabellen

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

Xero Connector-Tabellen
Name Beschreibung
Accounts Konten für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.
BankTransactions Banktransaktionen für eine Xero Organisation abfragen, einfügen und aktualisieren.
BankTransfers Nutzungsinformationen für die Operation BankTransfers.rsd.
BatchPayments BatchPayments für eine Xero-Organisation abfragen und einfügen.
ContactGroups Kontaktgruppen für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.
Contacts Kontakte für eine Xero Organisation abfragen, einfügen und aktualisieren.
CreditNotes Gutschriften für eine Xero-Organisation abfragen, einfügen und aktualisieren.
Employees Mitarbeiter für eine Xero-Organisation abfragen, einfügen und aktualisieren.
ExpenseClaims Spesenabrechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.
HistoryBankTransactions Abfragen und Einfügen des Banktransaktionsverlaufs und der Notizen für eine Xero-Organisation.
HistoryBatchPayments BatchPayment-Verlauf und Notizen für eine Xero-Organisation abfragen und einfügen.
HistoryContacts Kontaktverlauf und Notizen für eine Xero-Organisation abfragen und einfügen.
HistoryCreditNotes Abfragen und Einfügen des CreditNote-Verlaufs und von Notizen für eine Xero-Organisation.
HistoryInvoices Rechnungsverlauf und Notizen für eine Xero-Organisation abfragen und einfügen.
HistoryPurchaseOrders Bestellverlauf und Notizen für eine Xero-Organisation abfragen und einfügen.
Invoices Rechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.
Items Elemente für eine Xero Organisation abfragen, einfügen, aktualisieren und löschen.
LinkedTransactions LinkedTransactions für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.
ManualJournals Manuelle Journale für eine Xero Organisation abfragen, einfügen und aktualisieren.
Payments Zahlungen für eine Xero-Organisation abfragen, einfügen und löschen.
PurchaseOrders Bestellungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.
Quotes Angebote für eine Xero-Organisation abfragen
Receipts Abfragen, Einfügen und Aktualisieren von Belegen für eine Xero-Organisation.
TaxRates Nutzungsinformationen für die Operation TaxRates.rsd.
Konten

Konten für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.

Tabellenspezifische Informationen

Mit der Kontentabelle können Sie Konten für eine Xero-Organisation AUSWÄHLEN und EINFÜGEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Die folgenden Felder sind für Einfügungen erforderlich: Code, Name und Typ.

INSERT INTO Accounts (Name, Code, Type) VALUES ('John Doe', '2000', 'BANK')
Spalten
Name Typ Nur Lesen Beschreibung
AccountId [KEY] String True Die eindeutige, von Xero zugewiesene Kennung des Kontos.
Code String Falsch Vom Kunden definierter alphanumerischer Kontocode. Beispielsweise 200 oder SALES.
Name String Falsch Name des Kontos.
Type String Falsch Der Kontotyp. Gültige Werte sind BANK, CURRENT, CURRLIAB, DEPRECIATN, DIRECTCOSTS, EQUITY, Expense, FIXED, LIABILITY, NONCURRENT, OTHERINCOME, OVERHEADS, PREPAYMENT, REVENUE, SALES, TERMLIAB, PAYGLIABILITY, SUPERANNUATIONEXPENSE, SUPERANNUATIONLIABILITY und WAGESEXPENSE.
Description String Falsch Beschreibung des Kontos. Alle Konten außer Bankkonten geben dieses Element zurück.
TaxType String Falsch Die Steuerart. Beispielsweise INPUT oder NONE.
EnablePaymentsToAccount Boolean Falsch Beschreibt, ob Zahlungen auf das Konto angewendet werden können.
ShowInExpenseClaims Boolean Falsch Beschreibt, ob der Kontocode für die Verwendung mit Spesenabrechnungen verfügbar ist.
Class String True Der Kontoklassentyp. Beispielsweise ASSET oder EQUITY.
Status String Falsch Der Kontostatuscode.
SystemAccount String True Wird nur für Systemkonten wie SCHULDNER, GLÄUBIGER usw. zurückgegeben.
BankAccountNumber String Falsch Die mit dem Konto verknüpfte Bankkontonummer. Nur Kontotypen BANK.
CurrencyCode String Falsch Der mit dem Konto verknüpfte Währungscode. Nur BANK-Kontotypen.
ReportingCode String True Der Berichtscode. Nur für neuseeländische Organisationen verfügbar.
ReportingCodeName String True Der Berichtscodename. Nur für Organisationen in Neuseeland verfügbar.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am Benutzerdatensatz.
HasAttachments Boolean True Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
BankAccountType String Falsch Gültige Typen sind BANK, KREDITKARTE und PAYPAL
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Banktransaktionen

Abfragen, Einfügen und Aktualisieren von Banktransaktionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Mit der Tabelle „BankTransactions“ können Sie Banktransaktionen für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN, AKTUALISIEREN und LÖSCHEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Banktransaktionsdatensatz zu erstellen, sind neben mindestens einer Position die folgenden Felder erforderlich: Typ, Contact_ContactName oder Contact_ContactId und BankAccount_AccountId oder BankAccount_Code. Um eine neue Position zu erstellen, sind die folgenden Felder erforderlich: LineItem_Description, LineItem_Quantity, LineItem_UnitAmount und LineItem_AccountCode.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die LineItem-Spalten ohne das Präfix „LineItem_“, außer beim Zuweisen von Tracking-Kategorien. Weitere Einzelheiten finden Sie in der Xero Dokumentation der BankTransactions-API.

    INSERT INTO BankTransactions (Type, Contact_ContactName, BankAccount_Code, LineItemAggregate) VALUES (
      'RECEIVE',
      'John Doe',
      '200',
      '<LineItem>
            <Description>Monthly account fee</Description>
            <UnitAmount>49.90</UnitAmount>
            <TaxType>NONE</TaxType>
            <TaxAmount>0.00</TaxAmount>
            <LineAmount>49.90</LineAmount>
            <AccountCode>404</AccountCode>
            <Quantity>1.0000</Quantity>
       </LineItem>'
    )
    
  2. Sie können auch eine neue Position in ein vorhandenes Objekt einfügen, indem Sie die von Xero generierte Kennung des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einer vorhandenen Banktransaktion eine Position hinzu:

    INSERT INTO BankTransactions (BankTransactionId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. Löschen

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um einen Datensatz aus der Tabelle „BankTransactions“ zu löschen, müssen Sie das Feld „Status“ auf einen entsprechenden Wert aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der ID der Banktransaktion.
BankTransactionId String Falsch Die ID der Banktransaktion.
Type String Falsch Der Transaktionstyp. Gültige Werte sind RECEIVE, SPEND, RECEIVE-OVERPAYMENT, RECEIVE-PREPAYMENT, RECEIVE-TRANSFER, SPEND-OVERPAYMENT, SPEND-PREPAYMENT und SPEND-TRANSFER.
LineAmountTypes String Falsch Wie Einzelpostenwerte im Verhältnis zur Steuer bereitgestellt werden. Kann entweder „Exklusiv“, „Inklusiv“ oder „Keine Steuer“ sein.
Contact_ContactName String Falsch Der Name des mit der Transaktion verbundenen Kontakts.
Contact_ContactId String Falsch Die ID des mit der Transaktion verknüpften Kontakts.
BankAccount_AccountId String Falsch Die ID für das zugehörige Bankkonto.
BankAccount_AccountName String Falsch Der Name für das zugehörige Bankkonto.
BankAccount_Code String Falsch Der Code für das zugehörige Bankkonto.
LineItem_LineItemId String Falsch Die von Xero generierte ID der Banktransaktionsposition
LineItem_Description String Falsch Eine Beschreibung für die Position in der Banktransaktion.
LineItem_Quantity Double Falsch Die Menge des Gegenstands der Position. Dieser Wert muss größer oder gleich 0 sein.
LineItem_UnitAmount Decimal Falsch Der Stückbetrag des Betreffs der Position. Dieser Betrag muss positiv sein.
LineItem_AccountCode String Falsch Der Code für das referenzierte Konto. Es wird empfohlen, dieses Feld beim Buchen einzuschließen.
LineItem_Item_ItemId String Falsch Die ID des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Name String Falsch Der Name des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Code String Falsch Der Code des Artikels, auf den sich der Einzelposten bezieht.
LineItem_TaxType String Falsch Der Steuercode für die Transaktion. Dieses Feld wird als Überschreibung für den Standardsteuercode für das ausgewählte Konto verwendet.
LineItem_TaxAmount Decimal Falsch Der automatisch berechnete Steuerprozentsatz für den Zeilenbetrag, basierend auf dem Steuersatz.
LineItem_LineAmount Decimal Falsch Der Betrag der Position. Wenn entweder Quantity oder UnitAmount weggelassen werden, berechnet Xero den fehlenden Wert aus LineAmount.
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItemAggregate String Falsch Wird verwendet, um LineItem-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
IsReconciled Boolean Falsch Dieses Feld zeigt, ob diese Transaktion abgeglichen ist.
Date Date Falsch Das Datum der Transaktion.
Reference String Falsch Eine interne Xero Referenz für die Transaktion.
CurrencyRate Decimal Falsch Umrechnungskurs zur Basiswährung bei Geldausgabe oder -empfang. Beispiel: 0,7500. Dieses Feld wird nur für Banktransaktionen verwendet, die nicht in der Basiswährung erfolgen. Wenn dies für Konten, die nicht in der Basiswährung erfolgen, nicht angegeben ist, wird entweder der benutzerdefinierte Kurs oder der Tageskurs von XE.com verwendet.
URL String Falsch Ein Link zu einem Quelldokument.
Status String Falsch Der Statuscode der Banktransaktion. Die gültigen Werte sind AUTHORISED und DELETED.
SubTotal Decimal Falsch Der Gesamtbetrag der Transaktion ohne Steuern.
TotalTax Decimal Falsch Die Steuer auf die Banktransaktion.
Total Decimal Falsch Der Gesamtbetrag der Transaktion einschließlich Steuern.
PrepaymentId String Falsch Von Xero generierte eindeutige Kennung für eine Vorauszahlung. Diese wird bei Banktransaktionen mit dem Typ „SPEND-PREPAYMENT“ oder „RECEIVE-PREPAYMENT“ zurückgegeben.
OverpaymentId String Falsch Von Xero generierte eindeutige Kennung für eine Überzahlung. Diese wird bei Banktransaktionen mit dem Typ „ÜBERZAHLUNG AUSGEBEN“ oder „ÜBERZAHLUNG ERHALTEN“ zurückgegeben.
UpdatedDateUTC Datetime True Das Datum, an dem die Transaktion zuletzt aktualisiert wurde.
FullyPaidOnDate Date Falsch Das Datum, an dem die Transaktion vollständig bezahlt wurde.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Banküberweisungen

Nutzungsinformationen für die Operation BankTransfers.rsd.

Tabellenspezifische Informationen

Mit der Tabelle „BankTransfers“ können Sie Banküberweisungen für eine Xero-Organisation AUSWÄHLEN und EINFÜGEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Die folgenden Felder sind für Einfügungen erforderlich: FromBankAccount_Code, ToBankAccount_Code und Amount

INSERT INTO BankTransfers (FromBankAccount_Code, ToBankAccount_Code, Amount) VALUES ('3d08fd48-434d-4c18-a57b-831663ab70d2', 'ceef65a5-a545-423b-9312-78a53caadbc4', '1000.00')
Spalten
Name Typ Nur Lesen Beschreibung
BankTransferId [KEY] String True Die eindeutige, von Xero zugewiesene Kennung für die Banküberweisung.
FromBankAccount_Code String Falsch Der Code des Bankkontos, von dem Sie senden.
FromBankAccount_AccountId String Falsch Die Bankkonto-ID, von der Sie senden.
FromBankAccount_Name String Falsch Der Name des Bankkontos, von dem Sie senden.
ToBankAccount_Code String Falsch Der Bankkontocode, an den Sie senden.
ToBankAccount_AccountId String Falsch Die Bankkonto-ID, an die Sie senden.
ToBankAccount_Name String Falsch Der Name des Bankkontos, an das Sie senden.
Amount Decimal Falsch Der zu überweisende Geldbetrag.
Date Date Falsch Das Datum der Überweisung ist JJJJ-MM-TT.
CurrencyRate Decimal True Der Währungskurs.
FromBankTransactionID String True Die Banktransaktions-ID für das Quellkonto.
ToBankTransactionID String True Die Banktransaktions-ID für das Zielkonto.
HasAttachments Boolean True Boolescher Wert, um anzugeben, ob einer Banküberweisung ein Anhang beiliegt.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Stapelzahlungen

BatchPayments für eine Xero-Organisation abfragen und einfügen.

Tabellenspezifische Informationen

Mit der Tabelle BatchPayments können Sie Charge für eine Xero-Organisation AUSWÄHLEN und EINFÜGEN. Die ID-Spalte wird vom Connector generiert. Dieser Wert kombiniert den Index der einzelnen Zahlung innerhalb des Charge mit der eindeutigen, von Xero generierten BatchPaymentId

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelpostenspalten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung nach Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um eine neue Charge zu erstellen, sind neben mindestens einem Zahlungsposten auch die Felder „AccountId“, „Date“ und „Reference“ erforderlich; um einen Zahlungsposten einzufügen, sind die Felder „Payment_InvoiceId“ und „Payment_Amount“ erforderlich.

Sie können auch mehrere Zahlungen mithilfe eines XML-Aggregats bereitstellen, das die Daten für jede Zahlung im Charge enthält. Weitere Informationen zu den in jedem Zahlungseintrag unterstützten Elementen finden Sie in der Xero API -Dokumentation.

INSERT INTO BatchPayments (AccountId, Reference, Date, PaymentAggregate) VALUES (
  'AAAAA-AAAAA-AAAAA-AAAAA',
  '2019-03-01',
  '<Payment>
        <Invoice>
            <InvoiceID>5aa9451d-95d1-4f95-a966-bbab2573f71c</InvoiceID>
            <HasErrors>false</HasErrors>
            <IsDiscounted>false</IsDiscounted>
        </Invoice>
        <PaymentID>a22a64cb-364e-43fa-9a1f-bb2cd1f4adde</PaymentID>
        <Reference>ref/cheque</Reference>
        <Amount>913.55</Amount>
    </Payment>
    <Payment>
        ...
    </Payment>'
)
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Charge kombiniert mit der ID der Charge.
BatchPaymentId String True Die ID der Rechnung. Dieses Feld wird von Xero zugewiesen.
AccountId String Falsch Die ID des Kontos, das für die Zahlung verwendet wurde. Es muss sich entweder um ein Bankkonto handeln oder Zahlungen müssen aktiviert sein.
Particulars String Falsch (Nur NZ) Die Angaben, die auf der Abrechnung erscheinen.
Code String Falsch (Nur NZ) Der Transaktionscode, der auf dem Kontoauszug erscheint.
Reference String Falsch (Nur NZ) Die Transaktionsreferenz, die auf dem Kontoauszug erscheint.
Details String Falsch (Nur außerhalb Neuseelands) Die Details werden als Referenz für die Banktransaktion an die Bank der Organisation gesendet.
Narrative String Falsch (Nur Großbritannien) Eine Beschreibung, die nur in der Xero Kontoauszugszeile sichtbar ist
Date Date Falsch Das Datum, an dem die Zahlung erfolgt.
Payment_PaymentId String True Die ID der Zahlung. Dieses Feld wird von Xero zugewiesen.
Payment_InvoiceId String Falsch Die ID der Rechnung, für die die Zahlung erfolgte
Payment_BankAccountNumber String False Die Kontonummer der Bank, auf die die Zahlung erfolgt.
Payment_Particulars String Falsch (Nur NZ) Die Angaben, die auf der Abrechnung erscheinen.
Payment_Code String Falsch (Nur NZ) Der Transaktionscode, der auf dem Bankkonto des Lieferanten erscheint.
Payment_Reference String Falsch (Nur NZ) Die Transaktionsreferenz, die auf dem Bankkonto des Lieferanten erscheint.
Payment_Details String Falsch Die Daten werden als Referenz für die Banktransaktion an die Bank des Lieferanten übermittelt.
Payment_Amount Decimal Falsch Der gezahlte Betrag.
PaymentAggregate String Falsch Wird verwendet, um Zahlungszeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
Type String True Entweder PAYBATCH für Rechnungszahlungen oder RECBATCH für Verkaufszahlungen.
Status String Wahr Entweder AUTORISIERT oder GELÖSCHT
TotalAmount Decimal True Die Summe aller im Charge enthaltenen Zahlungen
IsReconciled Boolean True Ob die Charge abgeglichen wurde
UpdatedDateUTC Datetime True Das Datum, an dem die Charge zuletzt aktualisiert wurde.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
KontaktGruppen

Kontaktgruppen für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.

Tabellenspezifische Informationen

Mit der Tabelle „ContactGroups“ können Sie sowohl Kontaktgruppen als auch die Mitglieder dieser Kontaktgruppen verwalten.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung nach Einzelposten oder Journalzeilen. INSERT

Beim Einfügen mit einer Kontaktgruppe können Sie entweder eine neue Kontaktgruppe einfügen oder Kontakte zu einer vorhandenen Gruppe hinzufügen.

Um eine neue Kontaktgruppe einzufügen, muss nur das Feld Name ausgefüllt werden:

INSERT INTO ContactGroups (Name) VALUES ('Contractors')

Um einen Kontakt zu einer bestehenden Gruppe hinzuzufügen, müssen sowohl die ContactGroupId als auch die Contact_ContactId angegeben werden. Der Wert für das Feld Contact_ContactId kann durch Abfragen der Tabelle „Kontakte“ abgerufen werden.

INSERT INTO ContactGroups (ContactGroupId, Contact_ContactId) VALUES ('11111-11111-11111-11111', '22222-22222-22222-22222')

Mehrere Kontakte können über das ContactAggregate bereitgestellt werden:

INSERT INTO ContactGroups (ContactGroupId, ContactAggregate) VALUES (
  '11111-11111-11111-11111',
  '<Contact>
    <ContactID>22222-22222-22222-22222</ContactID>
   </Contact>
   <Contact>
    <ContactID>33333-33333-33333-33333</ContactID>
</Contact>')

AKTUALISIEREN

Beim Aktualisieren einer Kontaktgruppe können nur die Felder „Name“ und „Status“ geändert werden. Wenn Sie das Feld „Status“ auf „GELÖSCHT“ ändern, wird die Kontaktgruppe gelöscht.

-- Renaming the group
UPDATE ContactGroup SET Name = 'External Contractors' WHERE ContactGroupId = '11111-11111-11111-1111'


-- Deleting the group
UPDATE ContactGroup SET Status = 'DELETED' WHERE ContactGroupId = '11111-11111-11111-1111'

LÖSCHEN

Durch das Löschen von Einträgen aus einer Kontaktgruppe werden einzelne Kontakte aus der Gruppe entfernt.

DELETE FROM ContactGroups WHERE ID = '3|11111-11111-11111-11111'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der ID der Kontaktgruppe
ContactGroupId String Falsch Die eindeutige Xero Kennung für die Kontaktgruppe.
Name String Falsch Der Name der Kontaktgruppe.
Status String Falsch Der Status der Kontaktgruppe.
ContactAggregate String Falsch Wird verwendet, um Kontaktzeilen mithilfe von XML-Werten zu definieren. Nur zulässig, wenn ein INSERT in eine vorhandene Kontaktgruppe ausgeführt wird.
Contact_ContactId String Falsch Die eindeutige Kennung des Kontaktgruppenmitglieds
Contact_Name String True Der Name des Kontaktgruppenmitglieds
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Kontakte

Kontakte für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

In der Tabelle „Kontakte“ können Sie Kontakte für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Das Feld „Name“ ist erforderlich, um einen neuen Kontakt hinzuzufügen.

INSERT INTO Contacts (Name) VALUES ('John Doe')

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
ContactId [KEY] String True Die eindeutige Xero Kennung für den Kontakt.
Name String Falsch Der Kontaktname.
AccountNumber String Falsch Die mit dem Kontakt verknüpfte Kontonummer.
ContactNumber String Falsch Eine Kennung aus einem externen System. Obwohl dieses Feld auf dem Xero Kontaktbildschirm schreibgeschützt ist, kann es über die API aktualisiert werden.
CompanyNumber String Falsch Die Registrierungsnummer des Unternehmens. Die maximale Länge dieses Felds beträgt 50 Zeichen.
ContactStatus String Falsch Der Status des Kontakts. Verfügbare Statustypen sind AKTIV oder ARCHIVIERT.
FirstName String Falsch Der Vorname des Kontakts. Die maximale Länge dieses Felds beträgt 255 Zeichen.
LastName String Falsch Der Nachname des Kontakts. Die maximale Länge dieses Felds beträgt 255 Zeichen.
EmailAddress String Falsch Die Email Adresse des Kontakts. Die maximale Länge dieses Felds beträgt 500 Zeichen.
SkypeUserName String Falsch Der Skype-Benutzername des Kontakts.
ContactPerson1_FirstName String Falsch Vorname der Kontaktperson.
ContactPerson1_LastName String Falsch Nachname der Kontaktperson.
ContactPerson1_EmailAddress String Falsch Email Adresse Name der Kontaktperson.
ContactPerson1_IncludeInEmails Boolean False Ob Kontaktpersonen in Emails angegeben werden sollen.
ContactPerson2_FirstName String Falsch Vorname der Kontaktperson.
ContactPerson2_LastName String Falsch Nachname der Kontaktperson.
ContactPerson2_EmailAddress String Falsch Email Adresse Name der Kontaktperson.
ContactPerson2_IncludeInEmails Boolean False Ob Kontaktpersonen in Emails angegeben werden sollen.
ContactPerson3_FirstName String Falsch Vorname der Kontaktperson.
ContactPerson3_LastName String Falsch Nachname der Kontaktperson.
ContactPerson3_EmailAddress String Falsch Email Adresse Name der Kontaktperson.
ContactPerson3_IncludeInEmails Boolean False Ob Kontaktpersonen in Emails angegeben werden sollen.
ContactPerson4_FirstName String Falsch Vorname der Kontaktperson.
ContactPerson4_LastName String Falsch Nachname der Kontaktperson.
ContactPerson4_EmailAddress String Falsch Email Adresse Name der Kontaktperson.
ContactPerson4_IncludeInEmails Boolean False Ob Kontaktpersonen in Emails angegeben werden sollen.
BankAccountDetails String Falsch Die Bankkontonummer des Kontakts.
TaxNumber String Falsch Die regionsspezifische Steuernummer des Kontakts: ABN (Australien), GST (Neuseeland), VAT (Großbritannien) oder Steuernummer (USA und weltweit).
AccountsReceivableTaxType String Falsch Der für den Kontakt auf Debitorenrechnungen verwendete Standardsteuertyp.
AccountsPayableTaxType String Falsch Der für den Kontakt auf Kreditorenrechnungen verwendete Standardsteuertyp.
Street_AddressLine1 String Falsch Zeile 1 der Adresse.
Street_AddressLine2 String Falsch Zeile 2 der Adresse.
Street_AddressLine3 String Falsch Zeile 3 der Adresse.
Street_AddressLine4 String Falsch Zeile 4 der Adresse.
Street_City String Falsch Die Stadt.
Street_Region String Falsch Die Region.
Street_PostalCode String Falsch Die Postleitzahl.
Street_Country String Falsch Das Land.
Street_AttentionTo String Falsch Die „Zeile“ der Adresse.
POBox_AddressLine1 String Falsch Zeile 1 der Adresse.
POBox_AddressLine2 String Falsch Zeile 2 der Adresse.
POBox_AddressLine3 String Falsch Zeile 3 der Adresse.
POBox_AddressLine4 String Falsch Zeile 4 der Adresse.
POBox_City String Falsch Die Stadt.
POBox_Region String Falsch Die Region.
POBox_PostalCode String Falsch Die Postleitzahl.
POBox_Country String Falsch Das Land.
POBox_AttentionTo String Falsch Die „Zeile“ der Adresse.
DDI_PhoneNumber String Falsch Die Telefonnummer ohne Orts- oder Landesvorwahl.
DDI_PhoneAreaCode String Falsch Die Vorwahl.
DDI_PhoneCountryCode String Falsch Der Ländercode.
Default_PhoneNumber String Falsch Die Telefonnummer ohne Orts- oder Landesvorwahl.
Default_PhoneAreaCode String Falsch Die Vorwahl.
Default_PhoneCountryCode String Falsch Der Ländercode.
Fax_PhoneNumber String Falsch Die Telefonnummer ohne Orts- oder Landesvorwahl.
Fax_PhoneAreaCode String Falsch Die Vorwahl.
Fax_PhoneCountryCode String Falsch Der Ländercode.
Mobile_PhoneNumber String Falsch Die Telefonnummer ohne Orts- oder Landesvorwahl.
Mobile_PhoneAreaCode String Falsch Die Vorwahl.
Mobile_PhoneCountryCode String Falsch Der Ländercode.
UpdatedDateUTC Datetime True Der Zeitstempel der letzten Aktualisierung des Kontakts.
ContactGroupId String True Zeigt an, in welchen Kontaktgruppen ein Kontakt enthalten ist.
MergedToContactID String True Dieses Feld zeigt die Ziel-ID eines Kontakts an, der zusammengeführt wurde.
IsSupplier Boolean True Dieses Feld zeigt an, ob ein Kontakt Kreditorenrechnungen hat. Dieses Feld wird automatisch gesetzt, wenn eine Kreditorenrechnung für einen Kontakt generiert wird.
IsCustomer Boolean True Dieses Feld zeigt an, ob ein Kontakt Debitorenrechnungen hat. Dieses Feld wird automatisch gesetzt, wenn eine Debitorenrechnung für einen Kontakt generiert wird.
DefaultCurrency String Falsch Die Standardwährung für den Kontakt.
Website String True Die Website des Kontakts.
BrandingThemeId String True Die ID des Branding-Themas.
BrandingThemeName String True Der Name des Markenthemas.
PurchasesDefaultAccountCode String Falsch Der standardmäßige Einkaufskontocode für Kontakte.
PurchasesDefaultLineAmountType String True Der standardmäßige Betragstyp für Einkaufszeilen für Kontakte. Mögliche Werte sind: INCLUSIVE, EXCLUSIVE oder NONE.
SalesDefaultAccountCode String Falsch Der standardmäßige Verkaufskontocode für Kontakte.
SalesDefaultLineAmountType String True Der standardmäßige Verkaufszeilenbetragstyp für Kontakte. Mögliche Werte sind: INCLUSIVE, EXCLUSIVE oder NONE.
BatchPayments_BankAccountNumber String True Bankkontonummer für Stapelzahlung für den Kontakt.
BatchPayments_BankAccountName String True Name des Bankkontos für Stapelzahlung für den Kontakt.
BatchPayments_Details String True Stapelzahlungsdetails für den Kontakt.
Discount Decimal True Der Standardrabattsatz für den Kontakt.
Balances_AccountsReceivable_Outstanding Decimal True Die ausstehenden und überfälligen Beträge für Verkaufsrechnungen (Forderungen).
Balances_AccountsReceivable_Overdue Decimal True Die ausstehenden und überfälligen Beträge für Rechnungen (Kreditoren).
Balances_AccountsPayable_Outstanding Decimal True Die ausstehenden und überfälligen Beträge für Verkaufsrechnungen (Forderungen).
Balances_AccountsPayable_Overdue Decimal True Die ausstehenden und überfälligen Beträge für Rechnungen (Kreditoren).
PaymentTerms_Bills_Day Int True Die Standardzahlungsbedingungen für den Kontakt.
PaymentTerms_Bills_Type String True Die Standardzahlungsbedingungen für den Kontakt.
PaymentTerms_Sales_Day Int True Die Standardzahlungsbedingungen für den Kontakt.
PaymentTerms_Sales_Type String True Die Standardzahlungsbedingungen für den Kontakt.
SalesTrackingCategory1_Name String Falsch Der standardmäßige Kategoriename für die Verkaufsverfolgung für Kontakte.
SalesTrackingOption1_Name String Falsch Der Standardname der Verkaufsverfolgungsoption für Kontakte.
SalesTrackingCategory2_Name String Falsch Der standardmäßige Kategoriename für die Verkaufsverfolgung für Kontakte.
SalesTrackingOption2_Name String Falsch Der Standardname der Verkaufsverfolgungsoption für Kontakte.
PurchaseTrackingCategory1_Name String Falsch Der standardmäßige Kategoriename für die Kaufverfolgung für Kontakte.
PurchaseTrackingOption1_Name String Falsch Der Standardname der Kaufverfolgungsoption für Kontakte.
PurchaseTrackingCategory2_Name String Falsch Der standardmäßige Kategoriename für die Kaufverfolgung für Kontakte.
PurchaseTrackingOption2_Name String Falsch Der Standardname der Kaufverfolgungsoption für Kontakte.
HasAttachments Boolean True Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Gutschriften

Gutschriften für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Mit der CreditNotes-Tabelle können Sie Gutschriftspositionen für eine Xero Organisation AUSWÄHLEN, EINFÜGEN, AKTUALISIEREN und LÖSCHEN. Die ID-Spalte wird vom Connector generiert. Der Wert dieses Felds kombiniert den Index der Position mit der eindeutigen, von Xero generierten CreditNoteId.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um eine neue Gutschrift einzufügen, ist das Feld Contact_Name erforderlich. Damit eine Gutschrift genehmigt werden kann, müssen neben mindestens einer Position folgende Felder definiert werden: Contact_Name, Date und LineAmountTypes.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können auch ein neues Objekt mit mehreren Positionen mithilfe von XML-Aggregaten einfügen. Die hier unterstützten Elemente sind dieselben wie die LineItem-Spalten ohne das Präfix „LineItem_“, außer beim Zuweisen von Tracking-Kategorien. Weitere Einzelheiten finden Sie in der Xero Dokumentation der CreditNotes API.

    INSERT INTO CreditNotes (Type, Contact_Name, LineItemAggregate) VALUES (
      'ACCPAYCREDIT',
      'John Doe',
      '<LineItem>
        <Description>LineItemDesc1</Description>
        <Quantity>1</Quantity>
      </LineItem>
      <LineItem>
        <Description>LineItemDesc2</Description>
        <Quantity>2</Quantity>
      </LineItem>'
    )
    
  2. Sie können eine neue Position in ein vorhandenes Objekt einfügen, indem Sie die von Xero generierte Kennung des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einer vorhandenen Gutschrift eine Position hinzu:

    INSERT INTO CreditNotes (CreditNoteId, LineItem_Description, LineItem_Quantity) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. DELETE

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der ID der Gutschrift.
CreditNoteId String Falsch Die ID der Gutschrift.
CreditNoteNumber String Falsch Eine eindeutige Kennung für die Gutschrift, die sie für den Benutzer identifiziert.
Reference String Falsch Ein optionales Feld zum Speichern einer Referenz.
Type String Falsch Der Gutschriftstyp. Die gültigen Werte sind ACCPAYCREDIT und ACCRECCREDIT.
Contact_ContactId String Falsch Die ID des Kontakts.
Contact_Name String Falsch Der Name des Kontakts.
Date Date Falsch Das Datum, an dem die Gutschrift erstellt wurde.
Status String Falsch Der Status der Gutschrift.
LineAmountTypes String Falsch Der Zeilenbetragstyp, der bestimmt, ob Zeilenbeträge Steuern enthalten (Standard). Die gültigen Werte sind Exklusiv, Inklusiv und Keine Steuern. Gutschriften können nicht genehmigt werden, ohne dass dieses Feld definiert ist.
LineItem_LineItemId String Falsch Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Falsch Die Beschreibung für die Position der Gutschrift. Dieser Wert muss mindestens ein Zeichen lang sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_Quantity Double Falsch Die Menge des Gegenstands der Position. Dieser Wert muss größer oder gleich 0 sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_UnitAmount Decimal Falsch Der Stückbetrag des Betreffs der Position. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_ItemCode String Falsch Der benutzerdefinierte Artikelcode.
LineItem_AccountCode String Falsch Der Kontocode. Der Kontocode muss für die Organisation aktiv sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_Item_ItemId String Falsch Die ID des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Name String Falsch Der Name des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Code String Falsch Der Code des Artikels, auf den sich der Einzelposten bezieht.
LineItem_TaxType String Falsch Die Beschreibung für die Gutschriftposition. Dieser Wert muss mindestens ein Zeichen lang sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_TaxAmount Decimal Falsch Die Menge des Gegenstands der Position. Dieser Wert muss größer oder gleich 0 sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_LineAmount Decimal Falsch Die Summe des Felds „Menge“ multipliziert mit dem Feld „UnitAmount“ unter Berücksichtigung der Rabatte.
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Falsch Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur für Gutschriften vom Typ ACCREC unterstützt.
LineItemAggregate String Falsch Wird verwendet, um LineItem-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
SubTotal Decimal Falsch Der Zwischenbetrag der Gutschrift ohne Steuern.
TotalTax Decimal Falsch Die Gesamtsteuer auf der Gutschrift.
Total Decimal Falsch Der Gesamtbetrag der Gutschrift (Zwischensumme zuzüglich der gesamten Steuer).
UpdatedDateUTC Datetime True Das Datum, an dem die Gutschrift zuletzt aktualisiert wurde.
CurrencyCode String Falsch Die für die Gutschrift verwendete Währung.
FullyPaidOnDate Date Falsch Das Datum, an dem die Gutschrift vollständig bezahlt wurde.
SentToContact Boolean Falsch Dieses Feld gibt an, ob die Gutschrift über die Xero-App an den Kontakt gesendet wurde.
BrandingThemeId String Falsch Die ID des Branding-Themas.
CurrencyRate Decimal Falsch Umrechnungskurs zur Basiswährung bei Geldausgabe oder -empfang. Beispiel: 0,7500. Dieses Feld wird nur für Banktransaktionen verwendet, die nicht in der Basiswährung erfolgen. Wenn dies für Konten, die nicht in der Basiswährung erfolgen, nicht angegeben ist, wird entweder der benutzerdefinierte Kurs oder der Tageskurs von XE.com verwendet.
RemainingCredit Decimal Falsch Das verbleibende Guthaben für diese Gutschrift.
Allocation1_AppliedAmount Decimal True Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation1_Date Date True Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation1_InvoiceId String True Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation1_InvoiceNumber String True Die Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation2_AppliedAmount Decimal True Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation2_Date Date True Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation2_InvoiceId String True Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation2_InvoiceNumber String True Die Rechnung, auf die diese Zuweisung angewendet wurde.
PaymentIds String True Eine durch Kommas getrennte Liste von Zahlungs-IDs, die mit den Gutschriften verknüpft sind.
HasAttachments Boolean True Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Mitarbeiter

Mitarbeiter für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Mit der Mitarbeitertabelle können Sie Mitarbeiter für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Mitarbeiterdatensatz einzufügen, sind die folgenden Felder erforderlich: Vorname und Nachname.

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
EmployeeId [KEY] String True Die eindeutige Kennung des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
Status String Falsch Der Status des Mitarbeiters. Gültige Werte sind AKTIV und GELÖSCHT.
FirstName String Falsch Der Vorname des Mitarbeiters.
LastName String Falsch Der Nachname des Mitarbeiters.
ExternalLink_URL String Falsch Eine URL zu einer externen Ressource.
ExternalLink_Description String False Eine Beschreibung für den externen Link.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am Mitarbeiterdatensatz.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Spesenabrechnung

Spesenabrechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Mit der Tabelle „ExpenseClaims“ können Sie Spesenabrechnungen für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um einen neuen Spesenabrechnungsdatensatz zu erstellen, muss das Feld UserId definiert werden. Darüber hinaus muss mindestens eine ReceiptId angegeben werden. Eine kann entweder über die Spalte ReceiptId bereitgestellt werden:

INSERT INTO ExpenseClaims (UserId, ReceiptId) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY'
)

Mehrere können auch angegeben werden, indem sie in das ReceiptAggregate aufgenommen werden:

INSERT INTO ExpenseClaims (UserId, ReceiptAggregate) VALUES (
  'XXXXX-XXXXX-XXXXX-XXXXX',
  '<Receipt>
    <ReceiptID>YYYYY-YYYYY-YYYYY-YYYYY</ReceiptID>
  </Receipt>
  <Receipt>
    <ReceiptID>ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ</ReceiptID>
  </Receipt>'
)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Vorgänge werden gegenüber der Xero API als zwei Vorgänge gezählt. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
ExpenseClaimId [KEY] String True Die eindeutige Kennung der Spesenabrechnung.
UserId String False Die ID des zugehörigen Benutzers.
ReceiptAggregate String Falsch Wird verwendet, um Belegzeilen mit XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
ReceiptId String Falsch Die ID der Quittung.
Status String True Der Statuscode für die Spesenabrechnung. Die gültigen Werte sind SUBMITTED, AUTHORISED und PAID.
UpdatedDateUTC Datetime True Das Datum, an dem die Spesenabrechnung zuletzt aktualisiert wurde.
Total Decimal Wahr Der Gesamtbetrag einer gezahlten Spesenabrechnung.
AmountDue Decimal True Der für eine Spesenabrechnung zu zahlende Betrag.
AmountPaid Decimal Wahr Der für eine Spesenabrechnung noch zu zahlende Betrag.
PaymentDueDate Date True Das Datum, an dem die Spesenabrechnung bezahlt werden muss.
ReportingDate Date True Das Datum, an dem die Spesenabrechnung in Xero gemeldet wird.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
VerlaufBankTransaktionen

Abfragen und Einfügen des Banktransaktionsverlaufs und der Notizen für eine Xero-Organisation.

Tabellenspezifische Informationen

Die Tabelle HistoryBankTransactions ermöglicht es Ihnen, die zu einer Transaktion erstellten Notizen und den Änderungsverlauf dieser Transaktion zu lesen. Wenn keine BankTransactionId angegeben ist, wird der Verlauf aller BankTransactions abgerufen.

Zum Einfügen einer Notiz sind eine BankTransactionId und Details erforderlich:

INSERT INTO HistoryBankTransactions (BankTransactionId, Details) VALUES ('...', 'Refund for overpayment'),
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
BankTransactionId String True Die ID der Banktransaktion, zu der das Verlaufselement gehört.
Changes String Richtig Welche Art von Änderung gab es bei den Banktransaktionen?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
VerlaufStapelzahlungen

Abfragen und Einfügen des BatchPayment-Verlaufs und der Notizen für eine Xero-Organisation.

Tabellenspezifische Informationen

In der Tabelle HistoryBatchPayments können Sie die bei einer Charge erstellten Notizen und den Änderungsverlauf dieser Charge lesen. Wenn keine BatchPaymentId angegeben ist, wird der Verlauf aller Charge abgerufen.

Zum Einfügen einer Notiz sind eine BatchPaymentId und Details erforderlich:

INSERT INTO HistoryBatchPayments (BatchPaymentId, Details) VALUES ('...', 'Batch submitted on 3/1/2019')
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
BatchPaymentId String True Die ID des Elements, zu dem das Verlaufselement gehört.
Changes String Wahr Welche Art von Änderung ist am Artikel aufgetreten?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
GeschichteKontakte

Abfragen und Einfügen des Kontaktverlaufs und der Notizen für eine Xero-Organisation.

Tabellenspezifische Informationen

Die Tabelle „HistoryContacts“ ermöglicht es Ihnen, die zu einem Kontakt erstellten Notizen und den Änderungsverlauf dieses Kontakts zu lesen. Wenn keine Kontakt-ID angegeben ist, wird der Verlauf aller Kontakte abgerufen.

Zum Einfügen einer Notiz sind eine Kontakt-ID und Details erforderlich:

INSERT INTO HistoryContacts (ContactId, Details) VALUES ('...', 'Reliable customer'),
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
ContactId String True Die ID des Kontakts, zu dem das Verlaufselement gehört.
Changes String Wahr Welche Art von Änderung ist beim Kontakt aufgetreten?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
GeschichteCreditNotes

Abfragen und Einfügen des CreditNote-Verlaufs und von Notizen für eine Xero-Organisation.

Tabellenspezifische Informationen

Die Tabelle HistoryCreditNotes ermöglicht Ihnen, die zu einer Gutschrift erstellten Notizen und den Änderungsverlauf dieser Gutschrift zu lesen. Wenn keine CreditNoteId angegeben ist, wird der Verlauf aller CreditNotes abgerufen.

SELECT * FROM HistoryCreditNotes WHERE CreditNoteId = '...'

Zum Einfügen einer Notiz sind eine CreditNoteId und Details erforderlich:

INSERT INTO HistoryCreditNotes (CreditNoteId, Details) VALUES ('...', 'Offered 12% discount'),
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
CreditNoteId String True Die ID der Gutschrift, zu der das Verlaufselement gehört.
Changes String Richtig Welche Art von Änderung ist auf der Gutschrift erfolgt?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
VerlaufRechnungen

Rechnungsverlauf und Notizen für eine Xero-Organisation abfragen und einfügen.

Tabellenspezifische Informationen

Die Tabelle „HistoryInvoices“ ermöglicht es Ihnen, die auf einer Rechnung erstellten Notizen und den Änderungsverlauf dieser Rechnung zu lesen. Wenn keine Rechnungs-ID angegeben ist, wird der Verlauf aller Rechnungen abgerufen.

Zum Einfügen einer Notiz sind eine Rechnungs-ID und Details erforderlich:

INSERT INTO HistoryInvoices (InvoiceId, Details) VALUES ('...', 'Payment expected on December 1st'),
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
InvoiceId String True Die ID der Rechnung, zu der das Verlaufselement gehört.
Changes String Richtig Welche Art von Änderung ist auf der Rechnung aufgetreten?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
GeschichteBestellungen

Abfragen und Einfügen des Bestellverlaufs und der Notizen für eine Xero-Organisation.

Tabellenspezifische Informationen

Die Tabelle HistoryPurchaseOrders ermöglicht es Ihnen, die zu einer Bestellung erstellten Notizen und den Änderungsverlauf dieser Bestellung zu lesen. Wenn keine PurchaseOrderId angegeben ist, wird der Verlauf aller PurchaseOrders abgerufen.

Zum Einfügen einer Notiz sind eine PurchaseOrderId und Details erforderlich:

INSERT INTO HistoryPurchaseOrders (PurchaseOrderId, Details) VALUES ('...', 'Rescheduled delivery for October 9th'),
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Wahr Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
PurchaseOrderId String True Die ID der Bestellung, zu der das Verlaufselement gehört.
Changes String Richtig Welche Art von Änderung ist an der Bestellung aufgetreten?
Date Datetime Wahr Wann die Änderung erfolgte
User String True Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Falsch Die vorgenommene Änderung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Rechnungen

Rechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

In der Tabelle „Rechnungen“ können Sie Rechnungspositionen für eine Xero Organisation AUSWÄHLEN, EINFÜGEN, AKTUALISIEREN und LÖSCHEN. Die ID-Spalte wird vom Connector generiert. Dieser Wert kombiniert den Index der Position mit der eindeutigen, von Xero generierten Rechnungs-ID.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um eine neue Rechnung zu erstellen, müssen zusätzlich zu mindestens einer Position die Felder Type und ContactName festgelegt werden. Beachten Sie, dass für das LineItem-Aggregat mindestens auch LineItem_LineAmount oder LineItem_UnitAmount erforderliche Felder sind.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die LineItem-Spalten ohne das Präfix „LineItem_“, außer beim Zuweisen von Tracking-Kategorien. Weitere Einzelheiten finden Sie in der Xero Dokumentation der Invoices API.

    INSERT INTO Invoices (Type, ContactName, LineItemAggregate) VALUES (
      'ACCPAY',
      'Boom FM',
      '<LineItem>
        <ItemCode>12</ItemCode>
        <Description>Onsite project management </Description>
        <Quantity>1.0000</Quantity>
        <UnitAmount>1800.00</UnitAmount>
        <TaxType>OUTPUT</TaxType>
        <TaxAmount>225.00</TaxAmount>
        <LineAmount>1800.00</LineAmount>
        <AccountCode>200</AccountCode>
        <AccountId>4f2a3169-8454-4012-a642-05a88ef32982</AccountId>
        <Tracking>
            <TrackingCategory>
                <Name>Activity/Workstream</Name>
                <Option>Onsite consultancy</Option>
            </TrackingCategory>
        </Tracking>
        <LineItemID>52208ff9-528a-4985-a9ad-b2b1d4210e38</LineItemID>
       </LineItem>
       <LineItem>
        ...
       </LineItem>'
    )
    
  2. Sie können auch eine neue Position in ein vorhandenes Objekt einfügen, indem Sie den von Xero generierten Wert des vorhandenen Datensatzes angeben. Beispiel: Hinzufügen einer Position zu einer vorhandenen Rechnung:

    INSERT INTO Invoices (InvoiceId, LineItem_Description, LineItem_Quantity, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'New Line Item Desc', 1, 10)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. DELETE

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Rabattbeträge, Rabattsätze und Zeilenbeträge

Rechnungen in Xero können entweder mit einem festen Betrag (LineItem_DiscountAmount) oder mit einem Prozentsatz (LineItem_DiscountRate) rabattiert werden. Diese beiden Methoden sind nicht kompatibel, da Rabattbeträge präziser sind als Rabattsätze. Beispielsweise kann eine Position mit dem Betrag 2000,00 und einem Rabattbetrag von 99,99 nicht mit dem Rabattsatz 4,999 dargestellt werden, da Xero nur eine Genauigkeit von zwei Ziffern für Rabattsätze zulässt. Darüber hinaus bedeutet das Festlegen einer beliebigen Form von Rabatt, dass LineItem_LineAmount von Xero berechnet wird. Dies bedeutet, dass von den drei Feldern LIneItem_DiscountAmount, LineItem_DiscountAmount und LineItem_DiscountRate nur eines als Teil einer INSERT- oder UDPATE- Abfrage verwendet werden kann. Beispielsweise ist keine der folgenden Abfragen gültig:

INSERT INTO Invoices (Invoice, LineItem_LineAmount, LineItem_DiscountRate) VALUES ('2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e', 4999.99, 6.75)
UPDATE Invoices SET LineItem_DiscountRate = 12.50, LineItem_DiscountAmount = 99.99 WHERE ID = '1|2bf5f07b-edf0-4b05-9200-cc2cd6b89b1e'

Es bedeutet auch, dass der Connector die beiden anderen Werte entfernt, wenn er eines dieser Felder zuweist. Wenn Sie beispielsweise einer Rechnung einen LineItem_LineAmount zuweisen, entfernt der Connector alle dieser Rechnung zugeordneten Rabattwerte.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der ID der Rechnung.
InvoiceId String Falsch Die ID der Rechnung. Dieses Feld wird von Xero zugewiesen.
Type String Falsch Der Rechnungstyp. Die gültigen Werte sind ACCPAY und ACCREC.
ContactId String Falsch Die ID des Kontakts.
ContactName String Falsch Der Name des Kontakts. Dieser Wert ist beim Einfügen erforderlich.
LineItem_LineItemId String Falsch Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Falsch Die Beschreibung für die Position. Dieses Feld muss mindestens 1 Zeichen enthalten und ist zum Erstellen einer genehmigten Rechnung erforderlich.
LineItem_Quantity Double Falsch Die Menge des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich und muss null oder positiv sein.
LineItem_UnitAmount Decimal Falsch Der Stückbetrag des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_ItemCode String Falsch Der Code, der das zugehörige Element identifiziert.
LineItem_AccountCode String Falsch Der Kontocode. Dieser muss für die Organisation aktiv sein. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_Item_ItemId String Falsch Die ID des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Name String Falsch Der Name des Artikels, auf den sich der Einzelposten bezieht.
LineItem_Item_Code String Falsch Der Code des Artikels, auf den sich der Einzelposten bezieht.
LineItem_TaxType String Falsch Die Steuerart. Dieses Feld wird verwendet, um den AccountCode, den Standardsteuercode für das ausgewählte Konto, zu überschreiben.
LineItem_TaxAmount Decimal Falsch Der automatisch berechnete Steuerprozentsatz basierend auf dem Steuersatz für den Zeilenbetrag.
LineItem_LineAmount Decimal Falsch Die Summe der Menge multipliziert mit dem Stückpreis unter Berücksichtigung aller angewandten Rabatte.
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Falsch Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur auf Rechnungen vom Typ ACCREC (Verkauf) unterstützt.
LineItem_DiscountAmount Decimal Falsch Der Rabattbetrag, der auf die Position angewendet wird. Rabatte werden nur auf Rechnungen vom Typ ACCREC (Verkauf) unterstützt.
LineItemAggregate String Falsch Wird verwendet, um LineItem-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
Date Date Falsch Das Datum, an dem die Rechnung erstellt wurde.
DueDate Date Falsch Das Fälligkeitsdatum der Rechnung.
LineAmountTypes String Falsch Dieses Feld gibt an, ob die Zeilenbeträge Steuern enthalten (Standard). Wenn dieses Feld nicht angegeben ist, enthalten die Zeilenbeträge keine Steuern. Die gültigen Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
InvoiceNumber String Falsch Der eindeutige alphanumerische Code zur Identifizierung der Rechnung. Für Rechnungen vom Typ ACCREC. Wenn dieses Feld fehlt, wird es automatisch aus den Rechnungseinstellungen der Organisation generiert. Für Rechnungen vom Typ ACCPAY speichert dieses Feld einen nicht eindeutigen alphanumerischen Code zur Identifizierung der Rechnung.
Reference String Falsch Eine zusätzliche Referenznummer für Rechnungen vom Typ ACCREC.
BrandingThemeId String Falsch Die ID des Branding-Themas.
URL String Falsch Eine URL zu einem Quelldokument.
CurrencyCode String Falsch Der Währungscode nach ISO 4217.
CurrencyRate Decimal Falsch Der Währungskurs für eine Rechnung in mehreren Währungen. Wenn kein Kurs angegeben ist, wird der Tageskurs von XE.com verwendet.
Status String Falsch Der Statuscode für die Rechnung. Die gültigen Werte sind ENTWURF, ÜBERMITTELT und AUTORISIERT.
SentToContact Boolean Falsch Dieses Feld gibt an, ob die Rechnung als gesendet markiert werden soll. Dieses Feld kann nur für genehmigte Rechnungen festgelegt werden.
ExpectedPaymentDate Date True Das voraussichtliche Zahlungsdatum. Dieses Feld wird auf Verkaufsrechnungen (Forderungen) angezeigt.
PlannedPaymentDate Date True Das geplante Zahlungsdatum. Dieses Feld wird auf Rechnungen (Kreditoren) angezeigt.
SubTotal Decimal True Der Zwischenbetrag der Rechnung ohne Steuern.
TotalTax Decimal True Der Gesamtsteuerbetrag für die Rechnung.
Total Decimal True Der Gesamtbetrag der Rechnung einschließlich Steuern - die Summe aus „SubTotal“ und „TotalTax“.
TotalDiscount Decimal Wahr Summe der auf die Rechnungspositionen angewandten Rabatte.
HasAttachments Boolean True Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
PaymentIds String True Eine durch Kommas getrennte Liste von Zahlungs-IDs, die mit der Rechnung verknüpft sind.
PrePaymentIds String True Eine durch Kommas getrennte Liste von Vorauszahlungs-IDs, die mit der Rechnung verknüpft sind.
OverPaymentIds String True Eine durch Kommas getrennte Liste von Überzahlungs-IDs, die mit der Rechnung verknüpft sind.
CreditNoteIds String True Eine durch Kommas getrennte Liste von Gutschrift-IDs, die auf die Rechnung angewendet werden.
AmountDue Decimal True Der auf der Rechnung noch zu zahlende Betrag.
AmountPaid Decimal True Die Summe der für die Rechnung erhaltenen Zahlungen.
CISDeduction Decimal True Der von einem Auftragnehmer einbehaltene Abzug, der an HMRC zu zahlen ist. Nur für britische Organisationen verfügbar.
FullyPaidOnDate Date True Das Datum, an dem die Rechnung vollständig bezahlt wurde. Wird nur bei vollständig bezahlten Rechnungen zurückgegeben.
AmountCredited Decimal True Die Summe aller auf die Rechnung angerechneten Gutschriften, Überzahlungen und Vorauszahlungen.
UpdatedDateUTC Datetime True Das Datum, an dem die Rechnung zuletzt aktualisiert wurde.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Artikel

Abfragen, Einfügen, Aktualisieren und Löschen von Elementen für eine Xero-Organisation.

Tabellenspezifische Informationen

Die Artikeltabelle ermöglicht Ihnen das AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN von Artikeln für eine Xero-Organisation.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Artikeldatensatz einzufügen, muss das Feld Code definiert werden.

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Vorgänge werden gegenüber der Xero API als zwei Vorgänge gezählt. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
ItemId [KEY] String True Die eindeutige, von Xero zugewiesene Kennung für den Artikel.
Code String Falsch Ein benutzerdefinierter Code, der den Artikel identifiziert.
InventoryAssetAccountCode String Falsch Das Lagerbestandskonto für den Artikel. Das Konto muss vom Typ LAGERBESTAND sein. Der COGSAccountCode in PurchaseDetails ist auch erforderlich, um einen verfolgten Artikel zu erstellen.
Name String Falsch Der Name des Artikels.
PurchaseDescription String Falsch Die Kaufbeschreibung des Artikels.
Description String Falsch Eine Beschreibung des Artikels.
PurchaseDetails_UnitPrice String Falsch Der Stückpreis des Artikels.
PurchaseDetails_COGSAccountCode String Falsch Kosten des verkauften Warenkontos. Gilt nur für die Kaufdetails verfolgter Artikel.
PurchaseDetails_AccountCode String Falsch Der Code des Kontos, das für den gekauften Artikel verwendet werden soll.
PurchaseDetails_TaxType String Falsch Der Typ des Steuersatzes, der je nach Land unterschiedlich ist. Benutzerdefinierte Steuersätze haben einen Steuertyp von TAX001, TAX002, TAX003 usw.
SalesDetails_UnitPrice String Falsch Der Stückpreis des verkauften Artikels.
SalesDetails_COGSAccountCode String Falsch Kosten des verkauften Warenkontos. Gilt nur für die Kaufdetails verfolgter Artikel.
SalesDetails_AccountCode String Falsch Der Code des Kontos, das für den verkauften Artikel verwendet werden soll.
SalesDetails_TaxType String Falsch Der Typ des Steuersatzes, der je nach Land unterschiedlich ist. Benutzerdefinierte Steuersätze haben einen Steuertyp von TAX001, TAX002, TAX003 usw.
IsTrackedAsInventory Boolean Falsch Wahr für Artikel, die als Inventar verfolgt werden. Ein Artikel wird als Inventar verfolgt, wenn InventoryAssetAccountCode und COGSAccountCode festgelegt sind.
TotalCostPool Decimal True Der Wert des vorhandenen Artikels. Berechnet mithilfe der Durchschnittskostenrechnung.
QuantityOnHand Double True Die vorhandene Menge des Artikels.
IsSold Boolean Falsch Boolescher Wert, standardmäßig „true“. Wenn „IsSold“ „true“ ist, ist der Artikel bei Verkaufstransaktionen in der Xero-Benutzeroberfläche verfügbar. Wenn „IsSold“ auf „false“ aktualisiert wird, werden die Werte „Description“ und „SalesDetails“ auf Null gesetzt.
IsPurchased Boolean Falsch Boolescher Wert, standardmäßig „true“. Wenn „IsPurchased“ „true“ ist, ist der Artikel für Kauftransaktionen in der Xero-Benutzeroberfläche verfügbar. Wenn „IsPurchased“ auf „false“ aktualisiert wird, werden die Werte „PurchaseDescription“ und „PurchaseDetails“ auf null gesetzt.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am Artikeldatensatz.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Verknüpfte Transaktionen

Abfragen, Einfügen, Aktualisieren und Löschen von LinkedTransactions für eine Xero-Organisation.

Spalten
Name Typ Nur Lesen Beschreibung
LinkedTransactionID [KEY] String True Die Xero Kennung für eine verknüpfte Transaktion
SourceTransactionID String Falsch Die Kennung der Quelltransaktion (die Kaufkomponente einer abrechenbaren Ausgabe). Derzeit können nur Rechnungen vom Typ ACCPAY eine Quelltransaktion sein.
SourceLineItemID String Falsch Die Positionskennung aus der Quelltransaktion.
ContactID String Falsch Die Kennung für den Kontakt in der Zieltransaktion, d. h. den Kunden, dem die Ausgabe in Rechnung gestellt wird.
TargetTransactionID String Falsch Die Kennung der Zieltransaktion (der Verkaufskomponente einer abrechenbaren Ausgabe). Derzeit können nur Rechnungen vom Typ ACCREC eine Zieltransaktion sein.
TargetLineItemID String Falsch Die Positionskennung aus der Zieltransaktion. Beim Zuweisen einer abrechenbaren Ausgabe zu einer Zieltransaktion ist die TargetLineItemID optional.
Status String Falsch Der Status der verknüpften Transaktion. Dieser wird aus den Status der Quell- und Zieltransaktionen abgeleitet und kann nicht explizit festgelegt/aktualisiert werden.
Type String Falsch Dies wird immer BILLABLEEXPENSE sein. Weitere Typen können zukünftig hinzugefügt werden.
UpdatedDateUTC Datetime True Das letzte Änderungsdatum im UTC-Format
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
HandbuchJournals

Manuelle Journale für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Mit der ManualJournals-Tabelle können Sie manuelle Journalzeilen für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN. Die ID-Spalte wird vom Connector generiert; sie kombiniert den Index der Position mit der eindeutigen, von Xero generierten ManualJournalId.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen manuellen Journaleintrag einzufügen, ist neben mindestens zwei Positionen auch das Feld „Erzählung“ erforderlich. Ein Journaleintrag muss mindestens eine Gutschrift und eine Belastung enthalten, damit der Eintrag insgesamt ausgeglichen ist.

  1. Sie können mithilfe eines XML-Aggregats ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die JournalLine-Spalten ohne das Präfix „JournalLine_“, außer beim Zuweisen von Tracking-Kategorien. Weitere Einzelheiten finden Sie in der Xero Dokumentation der ManualJournals API.

    INSERT INTO ManualJournals (Narration, JournalLineAggregate) VALUES (
      'Accrued expenses',
      '<JournalLine>
            <Description>Coded incorrectly Office Equipment should be Computer Equipment</Description>
            <TaxType>NONE</TaxType>
            <LineAmount>-2569</LineAmount>
            <AccountCode>720</AccountCode>
        </JournalLine>
        <JournalLine>
            ...
        </JournalLine>'
    )
    
  2. Sie können auch eine neue Position in ein vorhandenes Objekt einfügen, indem Sie den von Xero generierten Wert des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einer vorhandenen Rechnung eine Position hinzu:

    INSERT INTO ManualJournals (ManualJournalId, JournalLine_LineAmount, JournalLine_AccountCode) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 55.00, '200')
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Journalzeilenindex kombiniert mit der ID des manuellen Journals.
ManualJournalId String Falsch Die ID des manuellen Journals.
Narration String Falsch Eine Beschreibung des Journals, das veröffentlicht wird.
JournalLine_LineAmount Decimal Falsch Die Summe für die Position. Dieser Wert ist positiv für Soll und negativ für Haben.
JournalLine_AccountCode String Falsch Der Kontocode, der das Konto identifiziert.
JournalLine_Description String Falsch Die Beschreibung für das manuelle Journal.
JournalLine_TaxType String Falsch Mit diesem Feld kann der Standardsteuercode für das ausgewählte Konto überschrieben werden.
JournalLine_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLine_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
JournalLineAggregate String Falsch Wird verwendet, um JournalLine-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
Date Date Falsch Das Datum, an dem das Journal veröffentlicht wurde.
Status String Falsch Der Statuscode für das manuelle Journal. Die gültigen Werte sind GÜLTIG, GEBUCHT, GELÖSCHT und UNGÜLTIG.
URL String Falsch Ein Link zu einem Quelldokument.
ShowOnCashBasisReports Boolean Falsch Dieses Feld gibt an, ob dieses Journal in Barmittelberichten enthalten sein soll. Der Standardwert ist „true“.
LineAmountTypes String Falsch Der Zeilenbetragstyp, der angibt, ob Zeilenbeträge Steuern enthalten (Standard). Wenn dieses Feld nicht angegeben ist, enthalten die Zeilenbetragssummen keine Steuern. Die gültigen Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
UpdatedDateUTC Datetime True Das Datum, an dem das manuelle Journal zuletzt aktualisiert wurde.
HasAttachments Boolean True Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Zahlungen

Abfragen, Einfügen und Löschen von Zahlungen für eine Xero-Organisation.

Tabellenspezifische Informationen

In der Zahlungstabelle können Sie Zahlungen für eine Xero-Organisation AUSWÄHLEN und EINFÜGEN.

Beachten Sie, dass diese Tabelle keine Zahlungen für Spesenabrechnungen enthält. Um diese abzurufen, müssen Sie die Ansicht „ExpenseClaimPayments“ lesen.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Zahlungsdatensatz einzufügen, sind die Felder „InvoiceNumber“ und „AccountCode“ erforderlich.

Spalten
Name Typ Nur Lesen Beschreibung
PaymentId [KEY] String True Die ID der Zahlung.
Date Date Falsch Das Datum, an dem die Zahlung erfolgt.
Amount Decimal Falsch Der Zahlungsbetrag. Dieser Wert muss kleiner oder gleich dem ausstehenden Rechnungsbetrag sein.
CurrencyRate Decimal Falsch Der Wechselkurs zum Zeitpunkt des Zahlungseingangs. Dieses Feld wird nur für Rechnungen und Gutschriften verwendet, die nicht in der Basiswährung angegeben sind.
Reference String Falsch Eine optionale Beschreibung für die Zahlung.
PaymentType String False Die Zahlungsart.
Status String Falsch Der Status der Zahlung.
UpdatedDateUTC Datetime Falsch Das Datum, an dem die Zahlung zuletzt aktualisiert wurde.
IsReconciled Boolean Falsch Dieses Feld gibt an, ob die Zahlung abgeglichen wurde. Nur verfügbar, wenn jeweils eine Zahlung abgefragt wird.
BatchPaymentId String True Wenn die Zahlung über BatchPayments übermittelt wurde, ist dies die ID des Charge, mit dem sie bereitgestellt wurde.
InvoiceId String Falsch Die ID der Rechnung. Geben Sie beim Anwenden einer Zahlung entweder die Rechnungs-ID oder die Rechnungsnummer an.
InvoiceNumber String Falsch Die Rechnungsnummer der Rechnung oder Gutschrift. Geben Sie beim Anwenden einer Zahlung entweder die Rechnungs-ID oder die Rechnungsnummer an.
CreditNoteId String Falsch Die ID der Gutschrift. Geben Sie beim Anwenden einer Zahlung entweder die CreditNoteId oder die CreditNoteNumber an.
CreditNoteNumber String Falsch Die Gutschriftnummer. Geben Sie beim Anwenden einer Zahlung entweder die CreditNoteId oder die CreditNoteNumber an.
AccountId String Falsch Die ID des Kontos, über das die Zahlung getätigt wurde. Der Kontotyp muss BANK sein oder Zahlungen auf das Konto müssen aktiviert sein.
AccountCode String Falsch Der Kontocode des Kontos, das für die Zahlung verwendet wurde.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Bestellungen

Abfragen, Einfügen und Aktualisieren von Bestellungen für eine Xero-Organisation.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der ID der Bestellung.
PurchaseOrderId String Falsch Die ID der Bestellung.
PurchaseOrderNumber String Falsch Eine eindeutige Kennung für die Bestellung, die sie für den Benutzer identifiziert.
Reference String Falsch Ein optionales Feld zum Speichern einer Referenz.
Type String Falsch Der Bestelltyp. Die gültigen Werte sind ACCPAYCREDIT und ACCRECCREDIT.
Contact_ContactId String Falsch Die ID des Kontakts.
Contact_Name String Falsch Der Name des Kontakts.
DeliveryDate Date Falsch Das Datum, an dem die Bestellung geliefert werden soll.
ExpectedArrivalDate Date Falsch Das voraussichtliche Datum, an dem der Kauf eintrifft.
DeliveryAddress String Falsch Die Adresse, an die die Ware geliefert werden soll.
AttentionTo String Falsch Die Person, an die die Lieferung geht.
Telephone String Falsch Die Telefonnummer der Person, die die Lieferung annimmt.
DeliveryInstructions String Falsch Freiformfeld für Informationen, die zur Durchführung der Lieferung erforderlich sind.
Date Date Falsch Das Datum, an dem die Bestellung erstellt wurde.
Status String Falsch Der Status der Bestellung.
LineAmountTypes String Falsch Der Zeilenbetragstyp, der bestimmt, ob Zeilenbeträge Steuern enthalten (Standard). Die gültigen Werte sind Exklusiv, Inklusiv und Keine Steuern. Bestellungen können nicht genehmigt werden, ohne dass dieses Feld definiert ist.
LineItem_LineItemId String Falsch Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Falsch Die Beschreibung für die Position der Bestellung. Dieser Wert muss mindestens ein Zeichen lang sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_Quantity Double Falsch Die Menge des Gegenstands der Position. Dieser Wert muss größer oder gleich 0 sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_UnitAmount Decimal Falsch Der Stückbetrag des Betreffs der Position. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_ItemCode String Falsch Der benutzerdefinierte Artikelcode.
LineItem_AccountCode String Falsch Der Kontocode. Der Kontocode muss für die Organisation aktiv sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_TaxType String Falsch Die Beschreibung für die Position der Bestellung. Dieser Wert muss mindestens ein Zeichen lang sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_TaxAmount Decimal Falsch Die Menge des Gegenstands der Position. Dieser Wert muss größer oder gleich 0 sein. Ohne diese Felder können Rechnungen nicht genehmigt werden.
LineItem_LineAmount Decimal Falsch Die Summe des Felds „Menge“ multipliziert mit dem Feld „UnitAmount“ unter Berücksichtigung der Rabatte.
LineItem_DiscountRate Double Falsch Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur bei Bestellungen vom Typ ACCREC unterstützt.
LineItemAggregate String Falsch Wird verwendet, um LineItem-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
SubTotal Decimal Falsch Der Zwischenbetrag der Bestellung ohne Steuern.
TotalTax Decimal Falsch Die Gesamtsteuer für die Bestellung.
Total Decimal Falsch Der Gesamtbetrag der Bestellung (Zwischensumme zuzüglich der gesamten Steuer).
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
UpdatedDateUTC Datetime True Das Datum, an dem die Bestellung zuletzt aktualisiert wurde.
HasAttachments Boolean True Gibt an, ob der Bestellung eine Datei angehängt ist.
CurrencyCode String Falsch Die für die Bestellung verwendete Währung.
BrandingThemeId String Falsch Die ID des Branding-Themas.
CurrencyRate Decimal Falsch Umrechnungskurs zur Basiswährung bei Geldausgabe oder -empfang. Beispiel: 0,7500. Dieses Feld wird nur für Banktransaktionen verwendet, die nicht in der Basiswährung erfolgen. Wenn dies für Konten, die nicht in der Basiswährung erfolgen, nicht angegeben ist, wird entweder der benutzerdefinierte Kurs oder der Tageskurs von XE.com verwendet.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Zitate

Angebote für eine Xero-Organisation abfragen

Tabellenspezifische Informationen

Mit der Tabelle „Angebote“ können Sie Angebotszeilen für eine Xero Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN. Die ID-Spalte wird vom Connector generiert; sie kombiniert den Index der Position mit der eindeutigen, von Xero generierten QuoteId.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelpostenspalten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung nach Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um ein neues Angebot einzufügen, sind neben mindestens einer Position auch die Felder „ContactId“ und „Date“ erforderlich. Eine Angebotsposition muss mindestens eine Beschreibung (LineItem_Description) enthalten.

  1. Sie können mithilfe eines XML-Aggregats ein neues Angebot mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die LineItem-Spalten ohne das Präfix „LineItem_“. Weitere Einzelheiten finden Sie in der Xero Dokumentation der Quotes API.

    INSERT INTO Quotes (ContactId, Date, LineItemAggregate) VALUES (
      '883628bc-7f22-4234-8a4c-81571816a8a1',
      '2023-11-21',
      '<LineItem>
            <Description>Example Description</Description>
        </LineItem>'
    )
    
  2. Sie können auch mehrere Angebote in einer einzigen Abfrage erstellen, indem Sie eine Masseneinfügung verwenden. Dazu sollten Sie in Ihrer Abfrage keine QuoteId einfügen und dann die Werte für die erste Position jedes hinzuzufügenden Angebots angeben.

    INSERT INTO Quotes (ContactId, Date, LineItem_Description)
      VALUES
    ('883628bc-7f22-4234-8a4c-81571816a8a1', '2023-11-21', 'Example Description'),
    ('883628bc-7f22-4234-8a4c-81571816a8a1', '2023-11-21', 'Example Description')
    
  3. Sie können auch neue Positionen in ein vorhandenes Objekt einfügen, indem Sie den von Xero generierten Wert des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einem vorhandenen Angebot zwei neue Positionen hinzu:

    INSERT INTO Quotes (QuoteId, LineItem_Description)
      VALUES
    ('fbb38812-dcc4-4e07-9ebd-2c38e1409b18', 'newItem1'),
    ('fbb38812-dcc4-4e07-9ebd-2c38e1409b18', 'newItem2')
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Falsch Der Positionsindex kombiniert mit der ID des Angebots.
QuoteId String Falsch Die ID des Angebots. Dieses Feld wird von Xero zugewiesen.
ContactId String Falsch Die ID des Kontakts.
ContactName String Falsch Der Name des Kontakts.
Date Date Falsch Das Datum, an dem das Angebot ausgestellt wurde.
ExpiryDate Date Falsch Das Datum, an dem das Angebot abläuft.
Status String Falsch Der Status des Angebots.
LineItem_LineItemId String Falsch Die von Xero generierte Kennung für eine Position.
LineItem_Description String Falsch Die Beschreibung der Position.
LineItem_Quantity Double Falsch Die Menge des zugehörigen Artikels in der Position.
LineItem_UnitAmount Decimal Falsch Der Stückbetrag des zugehörigen Artikels in der Position.
LineItem_ItemCode String Falsch Der Code, der das zugehörige Element identifiziert.
LineItem_AccountCode String Falsch Der Kontocode. Dieser muss für die Organisation aktiv sein.
LineItem_TaxType String Falsch Die Steuerart. Dieses Feld wird verwendet, um AccountCode, den Standardsteuercode für das ausgewählte Konto, zu überschreiben.
LineItem_TaxAmount Decimal Falsch Der automatisch berechnete Steuerprozentsatz basierend auf dem Steuersatz für den Zeilenbetrag.
LineItem_LineAmount Decimal Falsch Die Summe der Menge multipliziert mit dem Stückpreis unter Berücksichtigung aller angewandten Rabatte.
LineItem_DiscountRate Double Falsch Der Rabattprozentsatz, der auf die Position angewendet wird.
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
QuoteNumber String Falsch Der eindeutige alphanumerische Code zur Identifizierung des Angebots.
LineAmountTypes String Falsch Dieses Feld gibt an, ob die Zeilenbeträge Steuern enthalten. Gültige Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
Reference String Falsch Eine zusätzliche Referenznummer für Rechnungen vom Typ ACCREC.
CurrencyCode String Falsch Der Währungscode nach ISO 4217.
CurrencyRate Decimal Falsch Der Währungskurs für eine Rechnung in mehreren Währungen. Wenn kein Kurs angegeben ist, wird der Tageskurs von XE.com verwendet.
SubTotal Decimal Falsch Der Zwischenbetrag der Rechnung ohne Steuern.
TotalTax Decimal Falsch Der Gesamtsteuerbetrag für die Rechnung.
Total Decimal Falsch Der Gesamtbetrag der Rechnung einschließlich Steuern - die Summe aus „SubTotal“ und „TotalTax“.
TotalDiscount Decimal Falsch Summe der auf die Rechnungspositionen angewandten Rabatte.
BrandingThemeId String Falsch Die ID des Branding-Themas.
Terms String Falsch Die Bedingungen des Angebots.
UpdatedDateUTC Datetime Falsch Das Datum, an dem die Rechnung zuletzt aktualisiert wurde.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LineItemAggregate String Falsch Wird verwendet, um Zeilen für Angebotspositionen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
Quittungen

Abfragen, Einfügen und Aktualisieren von Belegen für eine Xero-Organisation.

Tabellenspezifische Informationen

Mit der Tabelle „Quittungen“ können Sie Quittungspositionen für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN, AKTUALISIEREN und LÖSCHEN. Die ID-Spalte wird vom Connector generiert; sie kombiniert den Index der Position mit der eindeutigen, von Xero generierten ReceiptId.

Beachten Sie, dass diese Tabelle nur Belegentwürfe enthält. Um Belege abzurufen, die bereits eingefordert wurden, müssen Sie die Ansicht „ExpenseClaimReceipts“ lesen.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen Belegdatensatz einzufügen, sind neben mindestens einer Position die folgenden Felder erforderlich: Datum, Kontaktname und Benutzer-Benutzer-ID. Um eine neue Position hinzuzufügen, sind die folgenden Felder erforderlich: Positionsbeschreibung, Positionsbetrag und Positionskontocode.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die LineItem-Spalten ohne das Präfix „LineItem_“, außer beim Zuweisen von Tracking-Kategorien. Weitere Einzelheiten finden Sie in der Xero Dokumentation der Receipts API.

    INSERT INTO Receipts (Date, Contact_Name, User_UserId, LineItemAggregate) VALUES (
      '4/19/2006 9:16:48 AM',
      'John Doe',
      'c81045b2-5740-4aea-bf8a-3956941af387',
      '<LineItem>
        <Description>Coffee with client</Description>
        <UnitAmount>13.00</UnitAmount>
        <AccountCode>200</AccountCode>
       </LineItem>
       <LineItem>
        <Description>Bagel</Description>
        <UnitAmount>2.00</UnitAmount>
        <AccountCode>200</AccountCode>
       </LineItem>'
    )
    
  2. Sie können auch eine neue Position in ein vorhandenes Objekt einfügen, indem Sie den von Xero generierten Wert des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einer vorhandenen Rechnung eine Position hinzu:

    INSERT INTO Receipts (ReceiptId, LineItem_Description, LineItem_UnitAmount) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'Coffee with client', 13.80)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. DELETE

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Positionsindex kombiniert mit der eindeutigen, von Xero generierten Kennung für den Beleg.
ReceiptId String Falsch Die eindeutige, von Xero generierte Kennung für das Script.
Date Date Falsch Das Datum des Belegs.
Contact_ContactId String Falsch Die ID des Kontakts. Beim Erstellen einer Quittung muss ein Kontakt angegeben werden.
Contact_Name String Falsch Der Name des Kontakts.
LineItem_Description String Falsch Die Beschreibung des Artikels.
LineItem_UnitAmount Decimal Falsch Die Stückzahl des Artikels.
LineItem_AccountCode String Falsch Der Code für das verknüpfte Konto.
LineItem_Quantity Double Falsch Die Menge des Artikels.
LineItem_TaxType String Falsch Die Steuerart. Mit diesem Feld kann der Standardsteuercode für das ausgewählte Konto überschrieben werden.
LineItem_LineAmount Decimal Falsch Die Summe aus Stückbetrag multipliziert mit der Menge.
LineItem_TrackingCategory1_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String False Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String False Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String False Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Falsch Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Falsch Der prozentuale Rabatt, der auf die Position angewendet wird.
LineItemAggregate String Falsch Wird verwendet, um LineItem-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
User_UserId String Falsch Der Benutzer in der Organisation, für den der Spesenabrechnungsbeleg bestimmt ist.
Reference String Falsch Zusätzliche Referenznummer.
LineAmountTypes String Falsch Dieses Feld gibt an, ob die Zeilenbeträge Steuern enthalten (Standard). Wenn dieses Feld nicht angegeben ist, enthalten die Zeilenbeträge keine Steuern. Die gültigen Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
SubTotal Decimal Falsch Der Gesamtbetrag der Quittung ohne Steuern.
TotalTax Decimal Falsch Der Gesamtsteuerbetrag auf der Quittung.
Total Decimal Falsch Der Gesamtbetrag der Quittung - die Summe aus Zwischensumme und Gesamtsteuer.
Status String True Der aktuelle Status der Quittung. Die gültigen Statustypen sind ENTWURF, ÜBERMITTELT, AUTORISIERT und ABGELEHNT.
ReceiptNumber String True Die von Xero generierte Nummer der Quittung in der aktuellen Forderung für den angegebenen Benutzer.
UpdatedDateUTC Datetime True Das Datum, an dem der Beleg zuletzt aktualisiert wurde.
HasAttachments Boolean True Dieses Feld gibt an, ob die Quittung Anhänge hat.
URL String True Ein Link zu einem Quelldokument.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Steuersätze

Nutzungsinformationen für die Operation TaxRates.rsd.

Tabellenspezifische Informationen

Mit der Tabelle „TaxRates“ können Sie Steuerkomponenten für Steuersätze in einer Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN. Die ID-Spalte wird vom Connector generiert. Dieser Wert kombiniert den Index der Position mit dem eindeutigen, von Xero generierten TaxType.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Steuersatz zu erstellen, muss das Feld Name zusätzlich zu mindestens einer Steuerkomponente festgelegt werden; die Felder TaxComponent_Name, TaxComponent_Rate und TaxComponent_IsCompound sind erforderlich, um eine neue Position einzufügen.

Diese Tabelle bietet neben dem Einfügen einer einzelnen Zeile zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die TaxComponent-Spalten ohne das Präfix „TaxComponent_“.

    INSERT INTO TaxRates (Name, TaxComponentAggregate) VALUES (
      'My Tax Rate',
      '<TaxComponent>
        <Name>customTax1</Name>
        <Rate>1.0000</Rate>
        <IsCompound>false</IsCompound>
       </TaxComponent>
       <TaxComponent>
        <Name>customTax2</Name>
        <Rate>2.0000</Rate>
        <IsCompound>false</IsCompound>
       </TaxComponent>'
    )
    
  2. Sie können auch eine neue Steuerkomponente in ein vorhandenes Objekt einfügen, indem Sie den von Xero generierten Wert für den vorhandenen Datensatz angeben. Beispiel: Hinzufügen einer Steuerkomponente zu einem vorhandenen Steuersatz:

    INSERT INTO TaxRates (TaxType, TaxComponent_Name, TaxComponent_Rate, TaxComponent_IsCompound) VALUES ('TAX001', 'customTax2', '2.0000', 'False')
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

Hinweis: Sie können vordefinierte Steuersätze nicht über die Xero API aktualisieren. LÖSCHEN

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String True Der Steuerkomponentenindex kombiniert mit dem Steuertyp.
TaxType String True Der Steuertyp für den Steuersatz. Es gibt Standardsteuersätze, zusätzlich können neue Steuersätze für eine Xero-Organisation eingerichtet werden. Alle neu hinzugefügten Steuersätze haben einen Steuertyp im Format TAX001, TAX002 usw.
Name String Falsch Der Name des Steuersatzes.
TaxComponent_Name String Falsch Der Name der Steuerkomponente
TaxComponent_Rate Double Falsch Der Steuersatz (bis zu 4dp).
TaxComponent_IsCompound Boolean Falsch Boolescher Wert, um zu beschreiben, ob der Steuersatz zusammengesetzt ist.
TaxComponentAggregate String Falsch Wird verwendet, um TaxComponent-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
Status String Falsch Der Status des Steuersatzes z. B. AKTIV, GELÖSCHT
ReportTaxType String Falsch Der Steuertyp des Berichts. Erforderlich für Organisationen in Australien, Neuseeland und Großbritannien (USA und Global unterstützen dieses Element nicht).
CanApplyToAssets Boolean True Boolescher Wert, um zu beschreiben, ob der Steuersatz für Vermögenskonten verwendet werden kann.
CanApplyToEquity Boolean True Boolescher Wert, um zu beschreiben, ob der Steuersatz für Eigenkapitalkonten verwendet werden kann.
CanApplyToExpenses Boolean True Boolescher Wert, um zu beschreiben, ob der Steuersatz für Aufwandskonten verwendet werden kann.
CanApplyToLiabilities Boolean True Boolescher Wert, um zu beschreiben, ob der Steuersatz für Verbindlichkeitskonten verwendet werden kann.
CanApplyToRevenue Boolean True Boolescher Wert, um zu beschreiben, ob der Steuersatz für Ertragskonten verwendet werden kann.
DisplayTaxRate Double True Steuersatz (Dezimalzahl auf 4dp), zB 12,5000.
EffectiveRate Double True Effektiver Steuersatz (Dezimalzahl auf 4dp), z. B. 12,5000.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

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.

Xero Connector-Ansichten
Name Beschreibung
AgedPayablesByContact Abfrage der Verbindlichkeiten mit Fälligkeit für einen Kontakt.
AgedReceivablesByContact Abfrage überfälliger Forderungen für einen Kontakt.
BalanceSheet Abfrage einer monatlichen Bilanz.
BankStatement Abfrage der auf dem Konto aufgeführten Umsätze.
BankSummary Abfrage der Salden und Geldbewegungen je Bankkonto.
BrandingThemes Abfrage der für die Xero-Organisation definierten Branding-Themen.
BudgetLines Budgetpositionen für eine Xero-Organisation abfragen
Budgets Budgetabfrage für eine Xero-Organisation
BudgetSummary Abfrage einer monatlichen Budgetübersicht.
ContactCISSettings CIS-Einstellungen für Kontakte in einer Xero-Organisation abfragen.
CreditNoteAllocations Gutschriftzuweisungen für eine Xero-Organisation abfragen.
Currencies Abfrage der Währungen für eine Xero-Organisation.
ExecutiveSummary Abfrage einer Zusammenfassung der Änderungen zwischen einem Monat und dem Vormonat
ExpenseClaimPayments Zahlungen für eine Xero-Organisation abfragen.
ExpenseClaimReceipts Abfrage beanspruchter Quittungen für eine Xero-Organisation.
HistoryBankTransfers Abfrage des Banküberweisungsverlaufs und der Notizen für eine Xero-Organisation.
HistoryExpenseClaims Abfrage des Spesenabrechnungsverlaufs und der Notizen für eine Xero-Organisation.
HistoryItems Elementverlauf und Notizen für eine Xero-Organisation abfragen.
HistoryOverpayments Abfrage des Überzahlungsverlaufs und der Notizen für eine Xero-Organisation.
HistoryPayments Zahlungsverlauf und Notizen für eine Xero-Organisation abfragen.
HistoryPrepayments Abfrage des Vorauszahlungsverlaufs und der Notizen für eine Xero-Organisation.
HistoryReceipts Abfrage des Empfangsverlaufs und der Notizen für eine Xero-Organisation.
HistoryRepeatingInvoices Abfrage des Verlaufs und der Notizen wiederkehrender Rechnungen für eine Xero-Organisation.
Journals Abfrage der Einzelposten in Journalen für eine Xero-Organisation.
Organisation Organisationsdaten für eine Xero-Organisation abfragen.
OrganisationActions Organisationsdaten für eine Xero-Organisation abfragen.
OverpaymentAllocations Abfrage von Überzahlungszuweisungen für eine Xero-Organisation.
Overpayments Abfrage von Überzahlungen für eine Xero-Organisation.
PrepaymentAllocations Vorauszahlungszuweisungen für eine Xero-Organisation abfragen.
Prepayments Vorauszahlungen für eine Xero-Organisation abfragen.
ProfitAndLoss Abfrage eines Gewinn- und Verlustberichts über einen Datumsbereich.
RepeatingInvoices Abfrage wiederkehrender Rechnungsvorlagen.
Tenants Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.
TrackingCategories Abfrageverfolgungskategorien für eine Xero-Organisation.
TrialBalance Abfrage einer monatlichen Bilanz.
Users Benutzer für eine Xero-Organisation abfragen.
AgedPayablesByContact

Frage nach Zahlungsfälligkeiten für einen Kontakt.

Tabellenspezifische Informationen

AUSWÄHLEN

Wenn die Kontakt-ID nicht angegeben wird, wird der Bericht über die Zahlungsrückstände für alle Kontakte nacheinander zurückgegeben.

Spalten
Name Typ Beschreibung
ID [KEY] String Die Zeilennummer, kombiniert mit der Kontakt-ID.
ContactId String Die ID des Kontakts, über den berichtet wird.
Date Datetime Das Datum, an dem die Rechnung erstellt wurde.
Reference String Bestellreferenz für diese Rechnung.
DueDate Datetime Datum, an dem der Betrag fällig ist.
Overdue Decimal Fälliger Betrag nach Fälligkeitsdatum.
Currency String Die für alle Felder außer DueLocal verwendete Währung oder leer, wenn die Standardwährung verwendet wird
Total Decimal Gesamtbetrag.
Paid Decimal Bezahlter Betrag.
Credited Decimal Gutgeschriebener Betrag.
Due Decimal Fälliger Betrag.
DueLocal Decimal Fälliger Betrag in der Standardwährung der Organisation.
InvoiceId String Die Rechnung zu dieser Rechnung.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
fromDate Datetime Alle zahlbaren Rechnungen ab diesem Datum für den Kontakt anzeigen.
toDate Datetime Alle bis zu diesem Datum zahlbaren Rechnungen für den Kontakt anzeigen.
Überfällige Forderungen nach Kontakt

Frage nach Fälligkeitsforderungen für einen Kontakt.

Tabellenspezifische Informationen

AUSWÄHLEN

Wenn die Kontakt-ID nicht angegeben wird, wird der Bericht über die Zahlungsrückstände für alle Kontakte nacheinander zurückgegeben.

Spalten
Name Typ Beschreibung
ID [KEY] String Die Zeilennummer, kombiniert mit der Kontakt-ID.
ContactId String Die ID des Kontakts, über den berichtet wird.
Date Datetime Das Datum, an dem die Rechnung erstellt wurde.
Reference String Verkaufsauftragsreferenz für diese Rechnung.
DueDate Datetime Datum, an dem der Betrag fällig ist.
Overdue Decimal Fälliger Betrag nach Fälligkeitsdatum.
Currency String Die für alle Felder außer DueLocal verwendete Währung. Ist leer, wenn keine Mehrfachwährung verwendet wird.
Total Decimal Gesamtbetrag.
Paid Decimal Bezahlter Betrag.
Credited Decimal Gutgeschriebener Betrag.
Due Decimal Fälliger Betrag.
DueLocal Decimal Fälliger Betrag in der Standardwährung der Organisation.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
fromDate Datetime Alle zahlbaren Rechnungen ab diesem Datum für den Kontakt anzeigen.
toDate Datetime Alle bis zu diesem Datum zahlbaren Rechnungen für den Kontakt anzeigen.
Bilanz

Fragen Sie eine monatliche Bilanz ab.

Spalten
Name Typ Beschreibung
ID [KEY] Integer Die Zeilennummer.
Label1 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label2 String Die Spalte „Wert“ des Bilanzberichts.
Label3 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label4 String Die Spalte „Wert“ des Bilanzberichts.
Label5 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label6 String Die Spalte „Wert“ des Bilanzberichts.
Label7 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label8 String Die Spalte „Wert“ des Bilanzberichts.
Label9 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label10 String Die Spalte „Wert“ des Bilanzberichts.
Label11 String Die Spalte „Beschriftung“ des Bilanzberichts.
Label12 String Die Spalte „Wert“ des Bilanzberichts.
Label13 String Die Spalte „Wert“ des Bilanzberichts.
AccountId String Die ID des Zeilenkontos aus dem Bilanzbericht.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
Date Datetime Stand: 01.07.2018
Periods Int Die Anzahl der Zeiträume, die von ToDate zurückgehen sollen.
Timeframe String Wie groß jeder Zeitraum sein soll (MONAT, QUARTAL oder JAHR)
TrackingOptionID1 String Alle bis zu diesem Datum zahlbaren Rechnungen für den Kontakt anzeigen.
TrackingOptionID2 String Alle bis zu diesem Datum zahlbaren Rechnungen für den Kontakt anzeigen.
PaymentsOnly Boolean Setzen Sie dies auf „True“, um nur Bargeldtransaktionen zu erhalten.
StandardLayout Boolean Wenn Sie diesen Parameter auf „true“ setzen, werden keine benutzerdefinierten Berichtslayouts auf die Antwort angewendet.
Bankauszug

Fragen Sie die auf dem Konto aufgeführten Transaktionen ab.

Tabellenspezifische Informationen

WÄHLEN

Bei der Abfrage dieser Ansicht kann eine Bankkonto-ID angegeben werden. Wenn keine angegeben wird, wird dieser Bericht für jedes in Xero gespeicherte Bankkonto ausgeführt.

Spalten
Name Typ Beschreibung
BankAccountId String Die ID des Bankkontos, über das berichtet wird
Date Date Das Datum, an dem die Transaktion stattgefunden hat
Description String Die Beschreibung der Transaktion
Reference String Referenzwert der Transaktion
Reconciled String Ob die Transaktion abgeglichen wurde („Ja“ oder „Nein“)
Source String Woher die Transaktion kam
Amount Decimal Der Wert der Transaktion
Balance Decimal Der laufende Gesamtbetrag der Abrechnung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
fromDate Date Das Startdatum der Anweisung
toDate Date Das Enddatum der Abrechnung. Muss innerhalb von 365 Tagen nach dem Beginn liegen.
BankZusammenfassung

Fragen Sie die Salden und Bargeldbewegungen für jedes Bankkonto ab.

Spalten
Name Typ Beschreibung
ID [KEY] Integer Die Zeilennummer.
BankAccount String Die Bankkontonummer.
OpeningBalance Decimal Betrag des Guthabens auf dem Konto zu Beginn des Finanzzeitraums.
CashReceived Decimal Dem Konto hinzugefügter Betrag.
CashSpent Decimal Vom Konto abgezogener Betrag.
FXGain Decimal Änderungen im Konto durch Währungsumrechnungen
ClosingBalance Decimal Betrag des Guthabens auf dem Konto am Ende des Finanzzeitraums.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
toDate Datetime Startdatum.
fromDate Datetime Anmeldeschluss.
PaymentsOnly Boolean Setzen Sie dies auf „True“, um nur Bargeldtransaktionen zu erhalten.
Markenthemen

Fragen Sie die für die Xero-Organisation definierten Branding-Themen ab.

Tabellenspezifische Informationen

In der Ansicht „BrandingThemes“ können Sie Branding-Themes für eine Xero-Organisation AUSWÄHLEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
BrandingThemeId [KEY] String Die eindeutige Xero Kennung für das Markenthema.
Name String Der Name des Markenthemas.
SortOrder Int Die Rangfolge des Branding-Themas. Der Wert für das Standard-Branding-Thema ist 0.
CreatedDateUTC Datetime Der Zeitstempel, wann das Branding-Thema erstellt wurde.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
BudgetLines

Abfrage von Budgetpositionen für eine Xero-Organisation

Spalten
Name Typ Beschreibung
Id [KEY] String Der Positionsindex kombiniert mit der ID des Kontos.
BudgetId String Die ID der Rechnung. Dieses Feld wird von Xero zugewiesen.
AccountId String Das Konto, das für diese Budgetposition gilt.
AccountCode String Der Code dieses Budgeteinzelpostenkontos.
Period String Das Jahr und der Monat, auf die sich der Saldo bezieht.
Amount Decimal Der für den Zeitraum auf dem Konto budgetierte Betrag.
Notes String Sämtliche Anmerkungen, die sich auf den Saldo beziehen.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
DateFrom Datetime Umfasst Budgetzeiträume, die ab diesem Datum beginnen.
DateTo Datetime Beinhaltet Budgetzeiträume bis zu diesem Datum.
Budgets

Budgets für eine Xero-Organisation abfragen

Spalten
Name Typ Beschreibung
BudgetId [KEY] String Die ID des Budgets. Dieses Feld wird von Xero zugewiesen.
Type String Der Budgettyp, entweder GESAMT oder VERFOLGUNG.
Description String Die Budgetbeschreibung.
TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie.
TrackingCategory1_OptionId String Die ID ist eine Tracking-Kategorieoption.
TrackingCategory1_Name String Der Name der Tracking-Kategorie.
TrackingCategory1_Option String Der Wert der Tracking-Kategorieoption.
TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie.
TrackingCategory2_OptionId String Die ID ist eine Tracking-Kategorieoption.
TrackingCategory2_Name String Der Name der Tracking-Kategorie.
TrackingCategory2_Option String Der Wert der Tracking-Kategorieoption.
UpdatedDateUTC Datetime Das Datum der letzten Aktualisierung des Budgets.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
BudgetZusammenfassung

Fragen Sie eine monatliche Budgetübersicht ab.

Spalten
Name Typ Beschreibung
ID [KEY] Integer Die Zeilennummer.
BankAccount String Die Bankkontonummer.
Period1 String Zeitraum 1 des Berichts
Period2 String Zeitraum 2 des Berichts
Period3 String Zeitraum 3 des Berichts
Period4 String Zeitraum 4 des Berichts
Period5 String Zeitraum 5 des Berichts
Period6 String Zeitraum 6 des Berichts
Period7 String Zeitraum 7 des Berichts
Period8 String Zeitraum 8 des Berichts
Period9 String Zeitraum 9 des Berichts
Period10 String Zeitraum 10 des Berichts
Period11 String Zeitraum 11 des Berichts
Period12 String Zeitraum 12 des Berichts
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
Date Datetime Stand: 01.07.2018
Periods Integer Die Anzahl der zu vergleichenden Zeiträume (Ganzzahl zwischen 1 und 12).
Timeframe Integer Die zu vergleichende Periodengröße: Geben Sie 1 für Monat, 3 für Quartal oder 12 für Jahr an.
KontaktCISEinstellungen

Fragen Sie die CIS-Einstellungen für Kontakte in einer Xero-Organisation ab.

Spalten
Name Typ Beschreibung
ContactId [KEY] String Die eindeutige Xero Kennung für den Kontakt.
CISEnabled Boolean Ob der Kontakt derzeit ein CIS-Subunternehmer ist
Rate Int Der CIS-Abzugssatz für den Kontakt in Prozent
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Gutschriftzuweisungen

Fragen Sie Gutschriftszuteilungen für eine Xero-Organisation ab.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Zuordnungsindex kombiniert mit der ID der Gutschrift.
CreditNoteId String Die ID der Gutschrift.
Allocation_AppliedAmount Decimal Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation_InvoiceId String Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Währungen

Fragen Sie die Währungen für eine Xero-Organisation ab.

Tabellenspezifische Informationen

In der Währungstabelle können Sie Währungen für eine Xero-Organisation AUSWÄHLEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Code [KEY] String Der Währungscode nach ISO 4217.
Description String Ein Name, der die Währung identifiziert.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Zusammenfassung

Abfrage einer Zusammenfassung der Änderungen zwischen einem Monat und dem Vormonat

Tabellenspezifische Informationen

AUSWÄHLEN

Bei der Abfrage dieser Ansicht kann ein Datum angegeben werden. Wenn es nicht angegeben wird, vergleicht dieser Bericht den aktuellen Monat mit dem vorherigen Monat.

Spalten
Name Typ Beschreibung
Metric String Der Wert, der zwischen den Monaten verglichen wird
ThisMonth Decimal Der Wert der Metrik in diesem Monat
PreviousMonth Decimal Der Wert der Metrik im vorherigen Monat
Variance Decimal Die prozentuale Differenz zwischen dem vorherigen Monat und diesem Monat.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
date Date Der Monat, der mit dem vorherigen Monat verglichen werden soll.
SpesenabrechnungZahlungen

Zahlungen für eine Xero-Organisation abfragen.

Spezifische Informationen anzeigen

Mit der Ansicht ExpenseClaimPayments können Sie Zahlungen für verschiedene Spesenabrechnungen für eine Xero-Organisation AUSWÄHLEN. Die ID-Spalte wird vom Connector generiert; sie kombiniert den Index der Position mit der eindeutigen, von Xero generierten ExpenseClaimID.

Beachten Sie, dass diese Tabelle keine anderen Zahlungsarten enthält. Um diese abzurufen, müssen Sie die Zahlungstabelle lesen.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Einzelpostenindex kombiniert mit der eindeutigen, von Xero generierten Kennung für die Spesenabrechnung.
ExpenseClaimId String Die ID der Spesenabrechnung, zu der diese Zahlung gehört
Date Date Das Datum, an dem die Zahlung erfolgt.
Amount Decimal Der Betrag der Zahlung. Dieser Wert muss kleiner oder gleich dem ausstehenden Betrag der Spesenabrechnung sein.
Reference String Eine optionale Beschreibung für die Zahlung.
AccountId String Die ID des Kontos, über das die Zahlung getätigt wurde. Der Kontotyp muss BANK sein oder Zahlungen auf das Konto müssen aktiviert sein.
AccountCode String Der Kontocode des Kontos, das für die Zahlung verwendet wurde.
AccountName String Der Kontocode des Kontos, das für die Zahlung verwendet wurde.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
SpesenabrechnungBelege

Abfrage beanspruchter Quittungen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Mit der Ansicht „ExpenseClaimReceipts“ können Sie geltend gemachte Belegpositionen für eine Xero-Organisation AUSWÄHLEN. Die ID-Spalte wird vom Connector generiert. Sie kombiniert den Index der Position mit der eindeutigen, von Xero generierten ExpenseClaimID.

Beachten Sie, dass diese Tabelle keine Belegentwürfe enthält. Um diese abzurufen, müssen Sie sie in der Tabelle „Belege“ lesen.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelpostenspalten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Einzelpostenindex kombiniert mit der eindeutigen, von Xero generierten Kennung für die Spesenabrechnung.
ExpenseClaimId String Die ID der Spesenabrechnung, zu der dieser Beleg gehört
ReceiptId String Die eindeutige, von Xero generierte Kennung für die Quittung.
Date Date Das Datum des Eingangs.
Contact_ContactId String Die ID des Kontakts. Beim Erstellen einer Quittung muss ein Kontakt angegeben werden.
Contact_Name String Der Name des Kontakts.
LineItem_Description String Die Beschreibung des Artikels.
LineItem_UnitAmount Decimal Die Stückzahl des Artikels.
LineItem_AccountCode String Der Code für das zugehörige Konto.
LineItem_Quantity Double Die Menge des Artikels.
LineItem_TaxType String Die Steuerart. Mit diesem Feld kann der Standardsteuercode für das ausgewählte Konto überschrieben werden.
LineItem_LineAmount Decimal Die Summe aus dem Stückbetrag multipliziert mit der Menge.
LineItem_TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Der prozentuale Rabatt, der auf die Position angewendet wird.
User_UserId String Der Benutzer in der Organisation, für den der Spesenabrechnungsbeleg bestimmt ist.
Reference String Zusätzliche Referenznummer.
LineAmountTypes String Dieses Feld gibt an, ob die Zeilenbeträge Steuern enthalten (Standard). Wenn dieses Feld nicht angegeben ist, enthalten die Zeilenbeträge keine Steuern. Die gültigen Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
SubTotal Decimal Der Gesamtbetrag der Quittung ohne Steuern.
TotalTax Decimal Der Gesamtsteuerbetrag auf der Quittung.
Total Decimal Der Gesamtbetrag der Quittung - die Summe aus Zwischensumme und Gesamtsteuer.
Status String Der aktuelle Status der Quittung. Die gültigen Statustypen sind ENTWURF, ÜBERMITTELT, AUTORISIERT und ABGELEHNT.
ReceiptNumber String Die von Xero generierte Nummer der Quittung in der aktuellen Forderung für den angegebenen Benutzer.
UpdatedDateUTC Datetime Das Datum der letzten Aktualisierung des Belegs.
HasAttachments Boolean Dieses Feld gibt an, ob die Quittung Anhänge hat.
URL String Ein Link zu einem Quelldokument.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteBanküberweisungen

Abfrage des Banküberweisungsverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „HistoryBankTransfers“ ermöglicht es Ihnen, die zu einer Überweisung erstellten Notizen und den Änderungsverlauf dieser Überweisung zu lesen. Wenn keine BankTransferId angegeben ist, wird der Verlauf aller BankTransfers abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
BankTransferId String Die ID der Banküberweisung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist bei den Banküberweisungen aufgetreten?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteAusgabenAnsprüche

Abfrage des Spesenabrechnungsverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „HistoryExpenseClaims“ ermöglicht es Ihnen, die zu einer Spesenabrechnung erstellten Notizen und den Verlauf der Änderungen an dieser Spesenabrechnung zu lesen. Wenn keine ExpenseClaimId angegeben ist, wird der Verlauf aller ExpenseClaims abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
ExpenseClaimId String Die ID der Spesenabrechnung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist an der Spesenabrechnung aufgetreten?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteArtikel

Abfrage des Artikelverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die HistoryItems-Ansicht ermöglicht es Ihnen, die zu einem Element erstellten Notizen und den Änderungsverlauf dieses Elements zu lesen. Wenn keine ItemId angegeben ist, wird der Verlauf aller Elemente abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
ItemId String Die ID des Elements, zu dem das Verlaufselement gehört.
Changes String Welche Art von Änderung wurde am Artikel vorgenommen?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteÜberzahlungen

Abfrage des Überzahlungsverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „Historische Überzahlungen“ ermöglicht es Ihnen, die zu einer Überzahlung erstellten Notizen und den Änderungsverlauf dieser Überzahlung zu lesen. Wenn keine Überzahlungs-ID angegeben ist, wird der Verlauf aller Überzahlungen abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
OverpaymentId String Die ID der Überzahlung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist bei der Überzahlung aufgetreten?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteZahlungen

Abfrage des Zahlungsverlaufs und der Notizen für eine Xero-Organisation.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
PaymentId String Die ID der Zahlung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist bei der Zahlung aufgetreten?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteVorauszahlungen

Abfrage des Vorauszahlungsverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „Historische Vorauszahlungen“ ermöglicht es Ihnen, die zu einer Vorauszahlung erstellten Notizen und den Verlauf der Änderungen an dieser Vorauszahlung zu lesen. Wenn keine Vorauszahlungs-ID angegeben ist, wird der Verlauf aller Vorauszahlungen abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
PrepaymentId String Die ID der Vorauszahlung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist bei der Vorauszahlung aufgetreten?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
GeschichteBelege

Abfrage des Empfangsverlaufs und der Notizen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „HistoryReceipts“ ermöglicht es Ihnen, die auf einer Quittung erstellten Notizen und den Änderungsverlauf dieser Quittung zu lesen. Wenn keine ReceiptId angegeben ist, wird der Verlauf aller Quittungen abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
ReceiptId String Die ID des Belegs, zu dem das Verlaufselement gehört.
Changes String Welche Art von Änderung ist auf dem Beleg erfolgt?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
VerlaufWiederkehrende Rechnungen

Abfrage des Verlaufs und der Notizen wiederkehrender Rechnungen für eine Xero-Organisation.

Spezifische Informationen anzeigen

Die Ansicht „HistoryRepeatingInvoices“ ermöglicht es Ihnen, die zu einer wiederkehrenden Rechnung erstellten Notizen und den Änderungsverlauf dieser wiederkehrenden Rechnung zu lesen. Wenn keine RepeatingInvoiceId angegeben ist, wird der Verlauf aller RepeatingInvoices abgerufen.

Spalten
Name Typ Beschreibung
Id [KEY] String Eine Kombination aus der Position des Verlaufselements und dem Zeitpunkt seines Auftretens.
RepeatingInvoiceId String Die ID der wiederkehrenden Rechnung, zu der das Verlaufselement gehört.
Changes String Welche Art von Änderung ist an der wiederkehrenden Rechnung vorgenommen worden?
Date Datetime Wann erfolgte die Änderung
User String Der Name des Benutzers, der die Änderung vorgenommen hat
Details String Die vorgenommene Änderung
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Zeitschriften

Fragen Sie die Einzelposten in Journalen für eine Xero-Organisation ab.

Tabellenspezifische Informationen

In der Journalansicht können Sie die Journalzeilen in Journalen für eine Xero-Organisation AUSWÄHLEN. Die ID-Spalte wird vom Connector generiert. Dieser Wert kombiniert den Index der Position mit der eindeutigen, von Xero generierten Journal-ID.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Zeitschriftenzeilenindex kombiniert mit der eindeutigen Xero-Kennung der Zeitschrift.
JournalId String Die eindeutige Xero Kennung der Zeitschrift.
JournalDate Date Das Datum, an dem das Journal veröffentlicht wurde.
JournalNumber Integer Die von Xero zugewiesene Journalnummer.
CreatedDateUTC Datetime Das Datum, an dem das Journal in das System eingegeben wurde.
Reference String Ein Referenzwert.
SourceId String Die Kennung für die Quelltransaktion (z. B. Rechnungs-ID).
SourceType String Der Journalquelltyp. Der Transaktionstyp, der das Journal erstellt hat. (z. B. ACCREC, ACCPAY, ACCRECCREDIT)
JournalLine_JournalLineId String Die eindeutige Xero Kennung des Journalpostens.
JournalLine_Description String Die Beschreibung der Journalposition.
JournalLine_AccountId String Das mit der Buchungsposition im Journal verknüpfte Konto.
JournalLine_AccountCode String Vom Kunden definierter alphanumerischer Kontocode, z. B. 200 oder SALES.
JournalLine_AccountType String Der Kontotyp, z. B. BANK, CURRENT oder CRRLIAB.
JournalLine_AccountName String Der Name des Kontos.
JournalLine_NetAmount Decimal Der Nettobetrag der Position. Dieser Wert ist positiv bei Sollbeträgen und negativ bei Habenbeträgen.
JournalLine_GrossAmount Decimal Der Nettobetrag zuzüglich Steuerbetrag.
JournalLine_TaxAmount Decimal Die Gesamtsteuer in einer Journalzeile.
JournalLine_TaxType String Der Typ des Steuersatzes, der je nach Land unterschiedlich ist. Benutzerdefinierte Steuersätze haben einen Steuertyp von TAX001, TAX002 usw.
JournalLine_TaxName String Ein Name, der die Steuerart identifiziert.
LineItem_TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
ModifiedAfter String Wenn festgelegt, werden nur Journale zurückgegeben, die seit diesem Zeitstempel erstellt oder geändert wurden, z. B. 2009-11-12T00:00:00.
PaymentsOnly Boolean Setzen Sie dies auf „True“, um nur Bargeldtransaktionen zu erhalten.
Offset Int Falls angegeben, werden nur Zeitschriften mit einer höheren JournalNumber zurückgegeben.
Organisation

Organisationsdaten für eine Xero-Organisation abfragen.

Tabellenspezifische Informationen

In der Organisationsansicht können Sie Organisationsdaten für eine Xero-Organisation AUSWÄHLEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
ShortCode [KEY] String Eine eindeutige Kennung für die Organisation.
APIKey String Eindeutiger API-Schlüssel für Xero-zu-Xero-Transaktionen.
Name String Anzeigename der in Xero angezeigten Organisation.
LegalName String Der Name der Organisation wird in Berichten angezeigt.
PaysTax Boolean Ob die Organisation bei einer örtlichen Steuerbehörde registriert ist.
Version String Die von der Organisation verwendete Xero-Version.
BaseCurrency String Standardwährung für die Organisation.
CountryCode String Ländercode der Organisation.
IsDemoCompany String Ob es sich bei der Organisation um ein Demounternehmen handelt.
OrganisationStatus String Wird auf AKTIV gesetzt, wenn Sie sich über die Xero API mit der Organisation verbinden können.
RegistrationNumber String Die Registrierungsnummer für Organisationen in Neuseeland, Australien und Großbritannien.
TaxNumber String Steuernummer der Organisation.
FinancialYearEndDay String Abschlusstag des Geschäftsjahres der Organisation. Beispielsweise 31.1.
FinancialYearEndMonth String Monat, in dem das Geschäftsjahr der Organisation endet. Beispielsweise 1-12.
PeriodLockDate Date Datum der Sperrfrist der Organisation.
EndOfYearLockDate Date Sperrdatum der Organisation zum Jahresende.
CreatedDateUTC Datetime Zeitstempel der Erstellung der Organisation in Xero.
UpdatedDateUTC Datetime Zeitstempel der letzten Änderung des Benutzerdatensatzes.
OrganisationEntityType String Der Entitätstyp der Organisation. Zum Beispiel FIRMA.
Timezone String Die Zeitzone für die Organisation.
Edition String BUSINESS oder PARTNER. Organisationen der Partner Edition haben eingeschränkte Funktionalität.
Class String Eines von: DEMO, TRIAL, STARTER, STANDARD, PREMIUM, PREMIUM_20, PREMIUM_50, PREMIUM_100, LEDGER, GST_CASHBOOK, NON_GST_CASHBOOK.
LineOfBusiness String Beschreibung der Geschäftsart der Organisation.
Street_AddressLine1 String Die Straßenadresse in Zeile 1.
Street_AddressLine2 String Die Straßenadresse in Zeile 2.
Street_AddressLine3 String Die Straßenadresse in Zeile 3.
Street_AddressLine4 String Die Straßenadresse in Zeile 4.
Street_City String Die Straßenadresse der Stadt.
Street_PostalCode String Die Postleitzahl der Straße und Hausnummer.
Street_Country String Das Land der Straßenadresse.
Street_Region String Die Region mit der Straßenadresse.
Street_AttentionTo String Die Adresszeile mit der Aufschrift „Zur Beachtung“.
POBox_AddressLine1 String Die Postfachadresszeile 1.
POBox_AddressLine2 String Die Postfachadresszeile 2.
POBox_AddressLine3 String Die Postfachadresse in Zeile 3.
POBox_AddressLine4 String Die Postfachadresse in Zeile 4.
POBox_City String Die Stadt der Postfachadresse.
POBox_PostalCode String Die Postleitzahl der Postfachadresse.
POBox_Country String Das Land der Postfachadresse.
POBox_Region String Die Region der Postfachadresse.
POBox_AttentionTo String Die Postfachadresse (z. Hd. Zeile).
DDI_PhoneNumber String Die DDI-Rufnummer.
DDI_PhoneAreaCode String Die DDI-Vorwahl.
DDI_PhoneCountryCode String Die DDI-Ländervorwahl.
Default_PhoneNumber String Die Standardtelefonnummer.
Default_PhoneAreaCode String Die Standardvorwahl.
Default_PhoneCountryCode String Der standardmäßige Ländercode.
Fax_PhoneNumber String Die Faxtelefonnummer.
Fax_PhoneAreaCode String Die Faxvorwahl.
Fax_PhoneCountryCode String Die Fax-Ländervorwahl.
Mobile_PhoneNumber String Die Handynummer.
Mobile_PhoneAreaCode String Die Mobilfunkvorwahl.
Mobile_PhoneCountryCode String Die Landesvorwahl für Mobiltelefone.
Facebook_URL String Die URL zur Facebook-Seite der Organisation.
Twitter_URL String Die URL zur Twitter-Seite der Organisation.
GooglePlus_URL String Die URL zur Google Plus-Seite der Organisation.
LinkedIn_URL String Die URL zur LinkedIn-Seite der Organisation.
Website_URL String Eine URL zur Website der Organisation.
PaymentTerms_Bills_Day String Standardmäßige Zahlungsbedingungen für Rechnungen (Tage).
PaymentTerms_Bills_Type String Standardmäßige Zahlungsbedingungen für Rechnungen (Typ).
PaymentTerms_Sales_Day String Standardmäßige Zahlungsbedingungen für Verkäufe (Tage).
PaymentTerms_Sales_Type String Standardmäßige Zahlungsbedingungen für Verkäufe (Typ).
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
OrganisationAktionen

Organisationsdaten für eine Xero-Organisation abfragen.

Spalten
Name Typ Beschreibung
Name [KEY] String Der Name der Berechtigung.
Status Bool Ob die Aktion für diese App zulässig ist.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Überzahlungszuweisungen

Überzahlungszuweisungen für eine Xero-Organisation abfragen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Zuordnungsindex kombiniert mit der ID der Überzahlung.
OverpaymentId String Die ID der Überzahlung.
Allocation_AppliedAmount Decimal Der Betrag, der von dieser Überzahlung auf eine bestimmte Rechnung angerechnet werden soll.
Allocation_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation_InvoiceId String Die ID der Rechnung, auf die diese Zuordnung angewendet wurde.
Allocation_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Überzahlungen

Überzahlungen für eine Xero-Organisation abfragen.

Spalten
Name Typ Beschreibung
OverpaymentId [KEY] String Die ID der Überzahlung.
Date Date Das Datum, an dem die Überzahlung geleistet wurde.
Type String Die Überzahlungsart. Die gültigen Werte sind RECEIVE-OVERPAYMENT und SPEND-OVERPAYMENT.
RemainingCredit Decimal Das verbleibende Guthaben der Überzahlung.
Contact_ContactId String Die ID des Kontakts.
Contact_Name String Der Name des Kontakts.
Status String Der Status der Überzahlung. Gültige Werte sind AUTORISIERT, BEZAHLT und STORNIERT.
SubTotal Decimal Der Zwischenbetrag für die Überzahlung, ohne Steuern.
TotalTax Decimal Die Gesamtsteuer für die Überzahlung.
Total Decimal Der Gesamtbetrag der Überzahlung einschließlich Steuern - die Summe aus „SubTotal“ und „TotalTax“.
LineItem_LineItemId String Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Die Beschreibung der Position. Dieses Feld muss mindestens 1 Zeichen enthalten und ist zum Erstellen einer genehmigten Rechnung erforderlich.
LineItem_Quantity Double Die Menge des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich und muss null oder positiv sein.
LineItem_UnitAmount Decimal Der Stückbetrag des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_ItemCode String Der Code, der den zugehörigen Artikel identifiziert.
LineItem_AccountCode String Der Kontocode. Dieser muss für die Organisation aktiv sein. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_TaxType String Die Steuerart. Dieses Feld wird verwendet, um den AccountCode, den Standardsteuercode für das ausgewählte Konto, zu überschreiben.
LineItem_TaxAmount Decimal Der automatisch berechnete Steuerprozentsatz für den Zeilenbetrag, basierend auf dem Steuersatz.
LineItem_LineAmount Decimal Die Summe der Menge multipliziert mit dem Stückpreis abzüglich aller gewährten Rabatte.
LineItem_TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur auf Rechnungen vom Typ ACCREC (Verkauf) unterstützt.
LineAmountTypes String Der LineAmount-Typ der Überzahlung. Gültige Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuer“.
CurrencyCode String Für die Überzahlung verwendete Währung.
CurrencyRate String Der Währungskurs für eine Überzahlung in mehreren Währungen. Wenn kein Kurs angegeben ist, wird der Tageskurs von XE.com verwendet.
UpdatedDateUTC Datetime Das Datum der letzten Aktualisierung der Überzahlung.
Allocation1_AppliedAmount Decimal Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation1_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation1_InvoiceId String Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation1_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
Allocation2_AppliedAmount Decimal Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation2_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation2_InvoiceId String Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation2_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
PaymentIds String Eine durch Kommas getrennte Liste von Zahlungs-IDs, die mit der Überzahlung in Zusammenhang stehen.
HasAttachments Boolean Boolescher Wert, um anzugeben, ob einer Überzahlung ein Anhang beiliegt.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Vorauszahlungszuweisungen

Abfrage von Vorauszahlungszuweisungen für eine Xero-Organisation.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Zuordnungsindex kombiniert mit der ID der Vorauszahlung.
PrepaymentId String Die ID der Vorauszahlung.
Allocation_AppliedAmount Decimal Der Betrag, der von dieser Vorauszahlung auf eine bestimmte Rechnung angerechnet werden soll.
Allocation_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation_InvoiceId String Die ID der Rechnung, auf die diese Zuweisung angewendet wurde.
Allocation_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Vorauszahlungen

Vorauszahlungen für eine Xero-Organisation abfragen.

Spalten
Name Typ Beschreibung
PrepaymentId [KEY] String Die ID der Vorauszahlung.
Date Date Das Datum, an dem die Vorauszahlung geleistet wurde.
Reference String Eine optionale Beschreibung für die Zahlung.
Type String Die Vorauszahlungsart. Die gültigen Werte sind RECEIVE-PREPAYMENT und SPEND-PREPAYMENT.
RemainingCredit Decimal Das verbleibende Guthaben der Vorauszahlung.
Contact_ContactId String Die ID des Kontakts.
Contact_Name String Der Name des Kontakts.
Status String Der Status der Vorauszahlung. Gültige Werte sind AUTORISIERT, BEZAHLT und STORNIERT.
SubTotal Decimal Der Zwischenbetrag für die Vorauszahlung, ohne Steuern.
TotalTax Decimal Die Gesamtsteuer für die Vorauszahlung.
Total Decimal Der Gesamtbetrag der Vorauszahlung einschließlich Steuern - die Summe aus „SubTotal“ und „TotalTax“.
LineItem_LineItemId String Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Die Beschreibung der Position. Dieses Feld muss mindestens 1 Zeichen enthalten und ist zum Erstellen einer genehmigten Rechnung erforderlich.
LineItem_Quantity Double Die Menge des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich und muss null oder positiv sein.
LineItem_UnitAmount Decimal Der Stückbetrag des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_ItemCode String Der Code, der den zugehörigen Artikel identifiziert.
LineItem_AccountCode String Der Kontocode. Dieser muss für die Organisation aktiv sein. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_TaxType String Die Steuerart. Dieses Feld wird verwendet, um den AccountCode, den Standardsteuercode für das ausgewählte Konto, zu überschreiben.
LineItem_TaxAmount Decimal Der automatisch berechnete Steuerprozentsatz für den Zeilenbetrag, basierend auf dem Steuersatz.
LineItem_LineAmount Decimal Die Summe der Menge multipliziert mit dem Stückpreis abzüglich aller gewährten Rabatte.
LineItem_TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur auf Rechnungen vom Typ ACCREC (Verkauf) unterstützt.
LineAmountTypes String Der LineAmount-Typ der Vorauszahlung. Gültige Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuer“.
CurrencyCode String Für die Vorauszahlung verwendete Währung.
CurrencyRate String Der Währungskurs für eine Vorauszahlung in mehreren Währungen. Wenn kein Kurs angegeben ist, wird der Tageskurs von XE.com verwendet.
UpdatedDateUTC Datetime Das Datum der letzten Aktualisierung der Vorauszahlung.
Allocation1_AppliedAmount Decimal Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation1_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation1_InvoiceId String Die ID der Rechnung, auf die diese Zuordnung angewendet wurde.
Allocation1_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
Allocation2_AppliedAmount Decimal Der Betrag dieser Gutschrift, der auf eine bestimmte Rechnung angerechnet werden soll.
Allocation2_Date Date Das Datum, an dem die Zuweisung vorgenommen wurde.
Allocation2_InvoiceId String Die ID der Rechnung, auf die diese Zuordnung angewendet wurde.
Allocation2_InvoiceNumber String Die Rechnung, auf die diese Zuordnung angewendet wurde.
PaymentIds String Eine durch Kommas getrennte Liste von Zahlungs-IDs, die mit der Vorauszahlung verknüpft sind.
HasAttachments Boolean Boolescher Wert, um anzugeben, ob einer Vorauszahlung ein Anhang beiliegt.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Gewinn und Verlust

Fragen Sie einen Gewinn- und Verlustbericht über einen Datumsbereich ab.

Tabellenspezifische Informationen

AUSWÄHLEN

Bei Verwendung dieses Berichts gibt es verschiedene Möglichkeiten, den Datumsbereich anzugeben:

1. Wenn keine Parameter angegeben werden, umfasst der Bericht den aktuellen Monat:

SELECT * FROM ProfitAndLoss

2. Wenn nur FromDate angegeben ist, reicht der Bericht vom FromDate bis zum aktuellen Datum:

SELECT * FROM ProfitAndLoss WHERE FromDate = '2018-01-01'

Hinweis

FromDate muss innerhalb eines Jahres nach dem aktuellen Datum liegen.

3. Wenn FromDate und ToDate angegeben sind, wird der Bericht von FromDate bis ToDate ausgeführt:

SELECT * FROM ProfitAndLoss WHERE FromDate = '2018-01-01' AND ToDate = '2018-04-01'

Hinweis

FromDate muss innerhalb eines Jahres nach ToDate liegen.

4. Wenn Perioden und Zeitrahmen angegeben sind, erstreckt sich der Bericht vom aktuellen Datum bis zum Beginn des angegebenen Zeitrahmens:

SELECT * FROM ProfitAndLoss WHERE Periods = 2 AND Timeframe = 'MONTH'

Notiz

Wenn Sie den Zeitraum „Monat“ angeben, kann die Xero API einen Bericht für die letzten 30 Tage ab Beginn des angegebenen Monats generieren, sogar für Monate mit 31 Tagen. Um dieses Problem zu umgehen, geben Sie in der Spalte „ToDate“ als zusätzliches Abfrage einen 31-tägigen Monat an.

SELECT * FROM ProfitAndLoss WHERE Periods = 11 AND Timeframe = 'MONTH' AND FromDate= '2023-10-01' AND ToDate= '2023-10-31'

5. Wenn Perioden, Zeitrahmen und BisDatum angegeben sind, erstreckt sich der Bericht vom BisDatum bis zum Beginn des angegebenen Zeitrahmens:

SELECT * FROM ProfitAndLoss WHERE Periods = 2 AND Timeframe = 'MONTH' AND ToDate = '2018-04-01'

Hinweis

Das Startdatum des Berichts wird auf den ersten Tag des aktuellen Monats festgelegt. ToDate muss auf ein späteres Datum innerhalb von 365 Tagen nach dem ersten Tag des aktuellen Monats festgelegt werden.

Spalten
Name Typ Beschreibung
ID [KEY] Integer Die Zeilennummer.
Label1 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label2 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label3 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label4 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label5 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label6 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label7 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label8 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label9 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label10 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label11 String Die Spalte „Label“ des ProfitAndLossStandard-Berichts.
Label12 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
Label13 String Die Spalte „Wert“ des ProfitAndLossStandard-Berichts.
AccountId String Die ID des Zeilenkontos aus dem ProfitAndLossStandardbericht.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
FromDate Datetime Alle zahlbaren Rechnungen ab diesem Datum für den Kontakt anzeigen.
ToDate Datetime Alle bis zu diesem Datum zahlbaren Rechnungen für den Kontakt anzeigen.
Periods Int Die Anzahl der Zeiträume, die von ToDate zurückgehen sollen.
Timeframe String Wie groß jeder Zeitraum sein soll (MONAT, QUARTAL oder JAHR)
TrackingCategoryID String Wenn Sie den Parameter „trackingCategoryID“ angeben, werden im Gewinn- und Verlustbericht die Zahlen für alle Optionen in der Kategorie als separate Spalten angezeigt.
TrackingOptionID String Wenn Sie diesen Parameter zusätzlich zur TrackingCategoryID angeben, wird nur eine Option zurückgegeben (d. h. nur 1 Spalte)
TrackingCategoryID2 String Wenn Sie einen zweiten „trackingCategoryID“-Parameter angeben, zeigt der Gewinn- und Verlustbericht die Zahlen für jede Optionskombination aus den beiden Kategorien als separate Spalten an.
TrackingOptionID2 String Wenn Sie diesen Parameter zusätzlich zu einer zweiten TrackingCategoryID angeben, wird nur eine Option zurückgegeben, kombiniert mit den Optionen aus der ersten Tracking-Kategorie.
PaymentsOnly Boolean Setzen Sie dies auf „True“, um nur Bargeldtransaktionen zu erhalten.
StandardLayout Boolean Wenn Sie diesen Parameter auf „true“ setzen, werden keine benutzerdefinierten Berichtslayouts auf die Antwort angewendet.
Wiederkehrende Rechnungen

Abfrage wiederkehrender Rechnungsvorlagen.

Tabellenspezifische Informationen

Mit der Ansicht „RepeatingInvoice“ können Sie die Positionen in wiederkehrenden Rechnungen für eine Xero-Organisation AUSWÄHLEN. Die ID-Spalte wird vom Connector generiert. Dieser Wert kombiniert den Index der Position mit der eindeutigen, von Xero generierten RepeatingInvoiceId.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Positionsindex kombiniert mit der ID der Rechnung.
RepeatingInvoiceId String Die ID der Rechnung. Dieses Feld wird von Xero zugewiesen.
Type String Der Rechnungstyp. Die gültigen Werte sind ACCPAY und ACCREC.
ContactId String Die ID des Kontakts. Dieser Wert wird beim Einfügen benötigt.
ContactName String Der Name des Kontakts. Dieser Wert ist beim Einfügen erforderlich.
Schedule_Period Integer Mit der Einheit für den geplanten Zeitraum verwendete Ganzzahl. Beispiel: 1 (alle 1 Woche).
Schedule_Unit String die Zeitplaneinheit. Die gültigen Werte sind WEEKLY oder MONTHLY.
Schedule_DueDate Integer Ganze Zahl, die mit dem Fälligkeitsdatumtyp für den geplanten Zeitraum verwendet wird. Beispiel: 20 (des Folgemonats).
Schedule_DueDateType String Der Fälligkeitsdatumstyp des Zeitplans. Die gültigen Werte sind DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, OFCURRENTMONTH und OFFOLLOWINGMONTH
Schedule_StartDate Date Rechnungsdatum: die erste Rechnung im Wiederholungsplan.
Schedule_NextScheduledDate Date Das Kalenderdatum der nächsten Rechnung im Zeitplan, die erstellt werden soll.
Schedule_EndDate Date Enddatum der Rechnung. Wird nur zurückgegeben, wenn für die Vorlage ein Enddatum festgelegt ist.
LineItem_LineItemId String Die von Xero generierte Kennung für einen Positionsartikel. Wenn in einer Aktualisierungsanforderung keine Positionsartikel-IDs enthalten sind, werden die Positionsartikel gelöscht und neu erstellt.
LineItem_Description String Die Beschreibung der Position. Dieses Feld muss mindestens 1 Zeichen enthalten und ist zum Erstellen einer genehmigten Rechnung erforderlich.
LineItem_Quantity Double Die Menge des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich und muss null oder positiv sein.
LineItem_UnitAmount Decimal Der Stückbetrag des zugehörigen Artikels in der Position. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_ItemCode String Der Code, der das zugehörige Element identifiziert.
LineItem_AccountCode String Der Kontocode. Dieser muss für die Organisation aktiv sein. Dieses Feld ist für die Rechnungsgenehmigung erforderlich.
LineItem_TaxType String Die Steuerart. Dieses Feld wird verwendet, um den AccountCode, den Standardsteuercode für das ausgewählte Konto, zu überschreiben.
LineItem_TaxAmount Decimal Der automatisch berechnete Steuerprozentsatz für den Zeilenbetrag, basierend auf dem Steuersatz.
LineItem_LineAmount Decimal Die Summe der Menge multipliziert mit dem Stückpreis abzüglich aller gewährten Rabatte.
LineItem_TrackingCategory1_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory1_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_CategoryName String Der Name einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionId String Die ID einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_OptionName String Die Option einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_TrackingCategory2_Option_Stat String Der Status einer Tracking-Kategorie. Die API ermöglicht die Definition von zwei optionalen Tracking-Kategorien.
LineItem_DiscountRate Double Der Rabattprozentsatz, der auf die Position angewendet wird. Rabatte werden nur auf Rechnungen vom Typ ACCREC (Verkauf) unterstützt.
LineAmountTypes String Dieses Feld gibt an, ob die Zeilenbeträge Steuern enthalten (Standard). Wenn dieses Feld nicht angegeben ist, enthalten die Zeilenbeträge keine Steuern. Die gültigen Werte sind „Exklusiv“, „Inklusiv“ und „Keine Steuern“.
Reference String Eine zusätzliche Referenznummer für Rechnungen vom Typ ACCREC.
BrandingThemeId String Die ID des Branding-Themas.
CurrencyCode String Der Währungscode nach ISO 4217.
Status String Der Statuscode für die Rechnung. Die gültigen Werte sind ENTWURF, ÜBERMITTELT und AUTORISIERT.
SubTotal Decimal Der Zwischenbetrag der Rechnung, ohne Steuern.
TotalTax Decimal Der Gesamtsteuerbetrag für die Rechnung.
Total Decimal Der Gesamtbetrag der Rechnung einschließlich Steuern - die Summe aus „SubTotal“ und „TotalTax“.
HasAttachments Boolean Dieses Feld gibt an, ob die Rechnung einen Anhang hat.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Mieter

Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.

Spalten
Name Typ Beschreibung
TenantId [KEY] String Eine eindeutige Kennung für den Mandanten.
Name String Der Name der Organisation oder Praxis
Type String Ob der Mieter eine Organisation oder eine Praxis ist
IsActive Boolean Ob die Verbindung derzeit diesen Mandanten verwendet
Tracking-Kategorien

Abfrageverfolgungskategorien für eine Xero-Organisation.

Tabellenspezifische Informationen

Mit der Ansicht „TrackingCategories“ können Sie Trackingkategorien für eine Xero-Organisation AUSWÄHLEN. Die ID-Spalte wird vom Connector generiert. Sie kombiniert den Index des Einzelpostens mit der eindeutigen, von Xero generierten TrackingCategoryId.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
Id [KEY] String Der Tracking-Optionsindex kombiniert mit der eindeutigen Xero-Kennung der Tracking-Kategorie.
TrackingCategoryId String Die eindeutige Xero-Kennung der Tracking-Kategorie.
Name String Der Name der Tracking-Kategorie. Beispielsweise Abteilung oder Region.
Status String Der Status einer Tracking-Kategorie. Dieser ist immer AKTIV.
TrackingOptionId String Die eindeutige Xero-Kennung der Tracking-Option.
OptionName String Der Name der Tracking-Kategorieoption. Beispielsweise Nord oder Süd.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Probebilanz

Fragen Sie eine monatliche Bilanz ab.

Spalten
Name Typ Beschreibung
ID [KEY] Integer Die Zeilennummer.
Account String Kontoname.
Debit String Sollbilanz für den aktuellen Monat bis zum angegebenen Datum.
Credit String Kreditbilanz für den aktuellen Monat bis zum angegebenen Datum.
YTDDebit String Soll seit Jahresbeginn.
YTDCredit String Gutschrift seit Jahresbeginn.
AccountId String Konto-ID
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Pseudo-Spalten

Pseudospaltenfelder werden in der WHERE-Klausel von SELECT-Anweisungen verwendet und bieten eine genauere Kontrolle über die Tupel, die von der Datenquelle zurückgegeben werden.

Name Typ Beschreibung
Date Datetime Stand: 01.07.2018
PaymentsOnly Boolean Setzen Sie dies auf „True“, um nur Bargeldtransaktionen zu erhalten.
Benutzer

Benutzerabfragen für eine Xero-Organisation.

Tabellenspezifische Informationen

In der Tabelle „Benutzer“ können Sie Benutzer für eine Xero-Organisation AUSWÄHLEN.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt kein Filtern nach Einzelposten oder Journalzeilen.

Spalten
Name Typ Beschreibung
UserId [KEY] String Die eindeutige Xero Kennung des Benutzers.
FirstName String Vorname des Benutzers.
LastName String Nachname des Benutzers.
EmailAddress String Email Adresse des Benutzers.
UpdatedDateUTC Datetime Zeitstempel der letzten Änderung des Benutzerdatensatzes.
IsSubscriber Boolean Gibt an, ob der Benutzer der Abonnent ist.
OrganisationRole String Rolle des Benutzers, Werte umfassen READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, MANAGEDCLIENT und CASHBOOKCLIENT.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Xero Connector
Name Beschreibung
AllocatetoInvoice Ordnet ein Dokument einer Rechnung zu.
CreateReportSchema Speichert einen dynamischen Gewinn- und Verlustbericht als benutzerdefiniertes Schema.
DownloadAttachment Ruft einen Anhang aus einem angegebenen Dokument in Xero ab.
DownloadPDF Lädt ein angegebenes Dokument im PDF-Format von Xero herunter.
GetLimitInfo Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.
GetOAuthAccessToken Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung bei Xero verwendet werden soll.
GetOAuthAuthorizationURL Ruft die OAuth-Autorisierungs URL für die Authentifizierung bei verschiedenen Xero Diensten ab.
ListAttachments Ruft eine Liste der Anhänge ab, die zu einem Dokument in Xero hochgeladen wurden.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.
RevokeTenant Trennt den Mandanten von dieser Anwendung. Der Benutzer muss sich das nächste Mal erneut autorisieren, wenn er diese Anwendung mit diesem Mandanten verbindet.
SendInvoiceEmail Sendet eine Email an die Kontakte einer Verkaufsrechnung
SwitchTenant Ändert den Mandanten, von dem diese Verbindung Daten abruft.
UploadAttachment Ruft eine Liste der Anhänge ab, die ein Element in Xero hat.
AllocatetoInvoice

Ordnet ein Dokument einer Rechnung zu.

Eingang
Name Typ Erforderlich Beschreibung
Type String True Der zuzuordnende Dokumenttyp. Zulässige Werte sind Gutschriften, Überzahlungen, Vorauszahlungen.
DocumentId String True Die ID des zuzuordnenden Dokuments.
InvoiceId String True Die Rechnung, der dieses Dokument zugeordnet wird.
AppliedAmount String True Der Betrag, der auf die Rechnung angewendet wird.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Date String Falsch Das Datum, an dem die Überzahlung angewendet wird.
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
Berichtsschema erstellen

Speichert einen dynamischen Gewinn- und Verlustbericht als benutzerdefiniertes Schema.

Berichtsschema erstellen

CreateReportSchema erstellt eine Schema basierend auf dem angegebenen Bericht.

Dieses Schema fügt Ihrer bestehenden Liste eine Tabelle hinzu, die den Ergebnissen Ihres Berichts entspricht und dann wie andere Tabellen abgefragt werden kann.

(Berichte von Xero werden vom Connector standardmäßig nicht als abfragbare Tabellen modelliert.)

Die generierte Schema enthält die Metadaten für den Bericht, z. B. Spalten und Spaltendatentypen. Sie können die Datei bearbeiten, um Datentypen anzupassen, Spalten umzubenennen und Spalten ein- oder auszuschließen.

Aktualisieren eines Berichtsschemas

Im folgenden Beispiel wird der SP CreateReportSchema erstellt einen neuen Bericht mit TestReportTest1 als Basisvorlage. Es fügt neue Spalten hinzu an TestReportTest1 und erstellt einen neuen Bericht mit dem Namen TestReport2 Der neue Bericht wird gespeichert als ...\TestReportTest2.rsd.

EXECUTE [CreateReportSchema]
   `[Berichtsname] `= "TestReportTest2",
   `[BenutzerdefinierteFeldIdsPrimitive] `= "1459925,1459928",
   `[CustomFieldIdsDropdown] `= "1469785",
   `[BenutzerdefinierteDimensionKeyIds] `= "13539564",
   `[Basisberichtsname] `= "TestReportTest1",
[FileName] = "...\TestReportTest2.rsd"

Eingabe

Name Typ Erforderlich Beschreibung
ReportName String True Name, der dem generierten Bericht gegeben werden soll. Wenn FileStream und die Verbindungseigenschaft „Location“ nicht festgelegt sind, wird die zugehörige Datei im Dateipfad abgelegt, der unter „Location“ festgelegt ist.
Periods Int Falsch Die Anzahl der Zeiträume, die von ToDate zurückgehen sollen.
Timeframe String Falsch Wie groß jeder Zeitraum sein soll (MONAT, QUARTAL oder JAHR)
TrackingCategoryID String Falsch Wenn Sie den Parameter „trackingCategoryID“ angeben, zeigt der Gewinn- und Verlustbericht die Zahlen für alle Optionen in der Kategorie als separate Spalten an.
TrackingCategoryID2 String Falsch Wenn Sie einen zweiten TrackingCategoryID-Parameter angeben, zeigt der Gewinn- und Verlustbericht Zahlen für jede Optionskombination aus den beiden Kategorien als separate Spalten an.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

Spalten des Ergebnissatzes

Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Wenn DownloadPath und FileStream nicht angegeben sind, enthält dies den Base64-codierten Inhalt der Datei.
Anhang herunterladen

Ruft einen Anhang aus einem angegebenen Dokument in Xero ab.

Eingang
Name Typ Erforderlich Beschreibung
Table String True Die Tabelle, die das Dokument mit dem Anhang enthält. Die zulässigen Werte sind Rechnungen, Quittungen, Gutschriften, Banktransaktionen, Banküberweisungen, Kontakte, Konten, manuelle Journale.
ObjectId String True Die eindeutige ID des Elements, von dem ein Anhang abgerufen werden soll.
Filename String True Der Name des abzurufenden Anhangs.
DownloadPath String Falsch Der Pfad der zu speichernden Datei. Muss ein Pfad zu einer Datei sein, nicht nur ein Verzeichnis.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Wenn DownloadPath und FileStream nicht angegeben sind, enthält dies den Base64-codierten Inhalt der Datei.
HerunterladenPDF

Lädt ein angegebenes Dokument im PDF-Format von Xero herunter.

Eingang
Name Typ Erforderlich Beschreibung
Table String True Die Tabelle enthält das herunterzuladende Dokument. Die zulässigen Werte sind Rechnungen, Gutschriften, Angebote.
ObjectId String True Die eindeutige ID des als PDF herunterzuladenden Elements.
DownloadPath String Falsch Der Pfad der zu speichernden Datei. Muss ein Pfad zu einer Datei sein, nicht nur ein Verzeichnis.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
FileData String Wenn DownloadPath und FileStream nicht angegeben sind, enthält dies den Base64-codierten Inhalt der Datei.
GetLimitInfo

Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.

Verfahrensspezifische Informationen

Dieses Verfahren meldet Informationen, die der Connector nach jeder API Anforderung zwischenspeichert. Wenn bei einer Verbindung keine Anforderungen an einen Mandanten gestellt wurden, meldet dieses Verfahren 0 Zeilen. Andernfalls wird LastModified Das Feld meldet, wann die Informationen in der Zeile zum letzten Mal aktualisiert wurden.

Wenn der letzte Änderungszeitpunkt zu lange her ist, als dass Ihre Anwendung ihn verwenden könnte, kann diese Tabelle durch Ausführen einer Abfrage aktualisiert werden. Die Abfrage muss mindestens eine Zeile lesen, um sicherzustellen, dass eine API Anforderung ausgelöst wird:

SELECT * FROM Organisation LIMIT 1

Spalten des Ergebnissatzes

Name Typ Beschreibung
TenantId String ID des Mandanten, für den das Limit gilt. Die Ausgabe enthält eine Zeile für jeden Mandanten, der während der Verbindung abgefragt wurde. Normalerweise gibt es nur eine.
AppRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 10.000). Dies gilt für alle Mandanten.
MinuteRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 60). Dies gilt nur für diesen Mandanten.
DayRemaining Integer Die Anzahl der API Aufrufe, die die aktuelle OAuth-App heute hat (max. 5000). Dies gilt nur für diesen Mandanten.
RetryAfter Integer Die empfohlene Wiederholungszeit, wenn einer der oben genannten Grenzwerte beim letzten API Aufruf an den Mandanten 0 war.
LastModified Datetime Wann diese Informationen zuletzt aktualisiert wurden. Die Werte in dieser Tabelle werden nur bei API -Aufrufen aktualisiert, daher kann dieser Wert älter sein als der aktuelle Zeitpunkt.
GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung mit Xero verwendet werden soll.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String True Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB.
AuthToken String Falsch Das von GetOAuthAuthorizationUrl zurückgegebene Authentifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich.
AuthKey String Falsch Der von GetOAuthAuthorizationUrl zurückgegebene AuthKey. Nur für den Web-Auth-Modus erforderlich.
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der im Developer Portal registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/').
Verifier String Falsch Das von Xero zurückgegebene Verifizierungstoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
PKCEVerifier String Falsch Der von GetOAuthAuthorizationURL zurückgegebene PKCEVerifier.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthAccessTokenSecret String Das von Xero zurückgegebene Authentifizierungstoken-Geheimnis. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL zur Authentifizierung bei verschiedenen Xero Diensten ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Dieser Wert ist nur erforderlich, wenn Sie Ihre eigene App registriert haben. Diese URL muss dieselbe Domäne haben wie die im Xero Developer Portal angegebene OAuth-Rückrufdomäne.
Scope String Falsch Die durch Leerzeichen getrennte Liste der Bereiche, die Sie von Xero anfordern. Standardmäßig werden alle Bereiche angefordert.
State String Falsch Ein Statustoken, das in die Autorisierungs URL aufgenommen werden soll. Standardmäßig nicht enthalten.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL zum Abschließen der Benutzerauthentifizierung.
AuthToken String Ein Token, das als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
AuthKey String Ein Schlüssel, der als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
PKCEVerifier String Ein zufälliger Wert, der als Eingabe für GetOAuthAccessToken im PKCE-Flow verwendet wird.
Anhänge auflisten

Ruft eine Liste der Anhänge ab, die für ein Dokument in Xero hochgeladen wurden.

Eingang
Name Typ Erforderlich Beschreibung
Table String True Die Tabelle, die das Dokument enthält, aus dem eine Liste der Anhänge abgerufen werden soll. Die zulässigen Werte sind Rechnungen, Quittungen, Gutschriften, Banktransaktionen, Banküberweisungen, Kontakte, Konten, manuelle Journale.
ObjectId String Falsch Die eindeutige ID des Dokuments, aus dem eine Liste der Anhänge abgerufen werden soll.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ergebnissatzspalten
Name Typ Beschreibung
AttachmentId String Die ID des Anhangs.
FileName String Der Dateiname des Anhangs.
URL String Die URL des Anhangs.
MimeType String Der Internetmedientyp des Anhangs.
ContentLength String Die Größe des Anhangs in Bytes.
Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
Mieter widerrufen

Trennt den Mandanten von dieser Anwendung. Der Benutzer muss die Autorisierung erneut durchführen, wenn er diese Anwendung das nächste Mal mit diesem Mandanten verbindet.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des zu widerrufenden Mieters, wie in der Mieteransicht angegeben
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ob die Verbindung erfolgreich widerrufen wurde
RechnungSendenE-Mail

Sendet eine Email an die Kontakte einer Verkaufsrechnung

Eingang
Name Typ Erforderlich Beschreibung
InvoiceId String True Die Rechnungs-ID der zu versendenden Rechnung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
Mieter wechseln

Ändert den Mandanten, von dem diese Verbindung Daten abruft.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des Mandanten, an den eine Verbindung hergestellt werden soll. Wenn leer, wird der aktuelle Mandant nicht geändert.
Ergebnissatzspalten
Name Typ Beschreibung
ActiveTenant String Die ID des Mandanten, der derzeit aktiv ist.
Anhang hochladen

Ruft eine Liste der Anhänge ab, die ein Element in Xero hat.

Eingang
Name Typ Erforderlich Beschreibung
Table String True Die Tabelle, die das Dokument mit dem Anhang enthält. Die zulässigen Werte sind Rechnungen, Quittungen, Gutschriften, Banktransaktionen, Banküberweisungen, Kontakte, Konten, manuelle Journale.
ObjectId String True Die eindeutige ID des Elements, von dem ein Anhang abgerufen werden soll.
FilePath String Falsch Der Speicherort der anzuhängenden Datei.
FileData String Falsch Base-64 codierte Daten für die Datei. Erforderlich, wenn FilePath nicht definiert ist.
Filename String Falsch Der Name der anzuhängenden Datei. Erforderlich, wenn FilePath nicht definiert ist.
ContentType String Falsch Der Typ der anzuhängenden Datei.
IncludeOnline String Falsch Legt einen Anhang fest, der der Rechnung beigefügt werden soll, wenn sie online angezeigt wird. Standardmäßig auf „Falsch“ eingestellt.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ein Boolescher Wert, der angibt, ob der Operation erfolgreich war.
AttachmentId String Die ID des Anhangs.
FileName String Der Dateiname des Anhangs.
URL String Die URL des Anhangs.
MimeType String Der Internetmedientyp des Anhangs.
ContentLength String Die Größe des Anhangs in Bytes.
IncludeOnline String Ein Boolescher Wert, der angibt, ob IncludeOnline auf „true“ gesetzt wurde.

Australisches Lohn- und Gehaltsdatenmodell

Der Xero-Connector modelliert die Xero Australian Payroll API als relationale Tabellen, Ansichten und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen sind in diesem Abschnitt dokumentiert. Sie können die SupportEnhancedSQL Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Beachten Sie jedoch, dass Löschungen von der Australian Payroll API nicht unterstützt werden.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Ansichten

Ansichten sind Tabellen, die nicht geändert werden können. Normalerweise werden Daten, die schreibgeschützt sind und nicht aktualisiert werden können, als Ansichten angezeigt.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen

in der Datenquelle verwendet werden.

Tabellen

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

Xero Connector-Tabellen
Name Beschreibung
Employees Mitarbeiter für eine Xero-Organisation abfragen, einfügen und aktualisieren.
LeaveApplications Urlaubsanträge für eine Xero Organisation abfragen, einfügen und aktualisieren.
PayItemsDeductions PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PayItemsEarnings PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PayItemsLeave PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PayItemsReimbursements PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PayrollCalendars Gehaltskalender für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PayRuns Gehaltsabrechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.
PaySlipDeductions Abfrage von Lohnabzugspositionen für eine Xero-Organisation.
PaySlipEarnings Abfrage der Gehaltsabrechnungspositionen für eine Xero-Organisation.
PaySlipLeaveAccrual Abfrage von Gehaltsabrechnungsposten für Urlaubsansprüche einer Xero-Organisation.
PaySlipReimbursements Abfrage von Lohnrückerstattungspositionen für eine Xero-Organisation.
PaySlipSuperannuations Abfrage von Gehaltsabrechnungspositionen für die Altersversorgung einer Xero-Organisation.
PaySlipTaxes Abfrage der Lohnsteuerpositionen für eine Xero-Organisation.
PaySlipTimesheetEarnings Abfrage von Gehaltsabrechnungs-, Arbeitszeitnachweis- und Verdienstpositionen für eine Xero-Organisation.
SuperFunds Abfragen, Einfügen und Aktualisieren von Payroll Super Funds in einer Xero-Organisation.
Timesheets Arbeitszeittabellen für eine Xero Organisation abfragen, einfügen und aktualisieren.
Mitarbeiter

Mitarbeiter für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
EmployeeID [KEY] String True Die eindeutige Kennung des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
Status String Falsch Der Status des Mitarbeiters. Gültige Werte sind AKTIV und BEENDET.
Title String Falsch Der Titel des Mitarbeiters.
FirstName String Falsch Der Vorname des Mitarbeiters.
MiddleNames String Falsch Der zweite Vorname des Mitarbeiters.
LastName String Falsch Der Nachname des Mitarbeiters.
DateOfBirth Date Falsch Der Geburtstag des Mitarbeiters.
JobTitle String Falsch Die Berufsbezeichnung des Mitarbeiters.
Gender String Falsch Das Geschlecht des Mitarbeiters.
Phone String Falsch Die private Telefonnummer des Mitarbeiters.
Mobile String Falsch Die Mobiltelefonnummer des Mitarbeiters.
Email String Falsch Die Email Adresse des Mitarbeiters.
StartDate Date Falsch Das Einstellungsdatum des Mitarbeiters.
TerminationDate Date Falsch Das Kündigungsdatum des Mitarbeiters.
TerminationReason String Falsch Der Kündigungsgrund des Arbeitgebers als einstelliger Code.
OrdinaryEarningsRateID String Falsch Ein Verweis auf die Lohntabelle des Mitarbeiters
PayrollCalendarID String Falsch Ein Verweis auf die Lohntabelle des Mitarbeiters
IsAuthorisedToApproveLeave Boolean Falsch Ob der Mitarbeiter berechtigt ist, Freizeit zu genehmigen.
IsAuthorisedToApproveTimesheets Boolean Falsch Ob der Mitarbeiter berechtigt ist, Stundenzettel zu genehmigen.
EmployeeGroupName String Falsch Der Name der Trackingkategorie, zu der der Mitarbeiter gehört, sofern eine zugewiesen ist.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am Mitarbeiterdatensatz.
HomeAddress_AddressLine1 String Falsch Adresszeile 1 für die Privatadresse des Mitarbeiters.
HomeAddress_AddressLine2 String Falsch Adresszeile 2 für die Privatadresse des Mitarbeiters.
HomeAddress_City String Falsch Vorort der Privatadresse des Mitarbeiters.
HomeAddress_Region String Falsch Staatliche Abkürzung für die Privatadresse des Mitarbeiters.
HomeAddress_PostalCode String Falsch Postleitzahl der Privatadresse des Mitarbeiters.
HomeAddress_Country String Falsch Land der Privatadresse.
TaxDeclaration_EmploymentBasis String Falsch Eine der folgenden Optionen: VOLLZEIT, TEILZEIT, GElegenheitsarbeit, ARBEITSZEIT oder SUPERINCOMESTREAM
TaxDeclaration_TFNExemptionType String Falsch Wenn der Mitarbeiter keine TFN hat, kann dies eine der folgenden sein: NOTQUOTED, PENDING, PENSIONER oder UNDER18
TaxDeclaration_TaxFileNumber String Falsch Die letzten drei Ziffern der TFN des Mitarbeiters
TaxDeclaration_AustralianResidentForTaxPurposes Boolean Falsch Ob der Arbeitnehmer für Steuerzwecke ein australischer Einwohner ist
TaxDeclaration_ResidencyStatus String Falsch Einer von AUSTRALIANRESIDENT, FOREIGNRESIDENT oder WORKINGHOLIDAYMAKER
TaxDeclaration_TaxFreeThresholdClaimed Boolean Falsch Gibt der Arbeitnehmer an, unter dem steuerfreien Betrag zu verdienen
TaxDeclaration_TaxOffsetEstimatedAmount Decimal Falsch Alle anderen Steuervergünstigungen, die der Arbeitnehmer geltend gemacht hat
TaxDeclaration_HasHELPDebt Boolean Falsch Ob der Arbeitnehmer HECS- oder HELP-Schulden hat
TaxDeclaration_HasSFSSDebt Boolean Falsch Ob der Arbeitnehmer Schulden hinsichtlich finanzieller Zuschüsse hat
TaxDeclaration_HasTradeSupportLoanDebt Boolean Falsch Ob der Mitarbeiter ein Handelsförderungsdarlehen hat
TaxDeclaration_UpwardVariationTaxWithholdingAmount Decimal Falsch Der vom Arbeitnehmer beantragte zusätzliche Abzug in Prozent
TaxDeclaration_EligibleToReceiveLeaveLoading Boolean Falsch Wenn der Arbeitnehmer Anspruch auf einen Mehrverdienst hat, wenn er Urlaub nimmt
TaxDeclaration_ApprovedWithholdingVariationPercentage Decimal Falsch Der dem Arbeitnehmer gewährte zusätzliche Steuerabzug in Prozent
BankAccounts String True Die Bankkonten des Mitarbeiters im XML-Format.
PayTemplate String True Die Lohnvorlage für den Mitarbeiter im XML-Format.
OpeningBalances String True Die Eröffnungssalden des Mitarbeiters im XML-Format.
LeaveBalances String True Die Urlaubsguthaben des Mitarbeiters im XML-Format.
SuperMemberships String True Die Super-Mitgliedschaften für den Mitarbeiter im XML-Format.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Urlaubsanträge

Urlaubsanträge für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Mit der Tabelle „Zeiterfassung“ können Sie Urlaubsanträge für eine Xero-Organisation AUSWÄHLEN und EINFÜGEN. Die ID-Spalte wird vom Connector generiert. Der Wert dieses Felds kombiniert den Index des Einzelpostens mit der eindeutigen, von Xero generierten LeaveApplicationID.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um einen neuen Urlaubsantrag einzufügen, sind EmployeeID, LeaveTypeID, Title, StartDate und EndDate erforderlich. Darüber hinaus können auch Urlaubszeiträume angegeben werden.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Zeilenelementen einfügen. Die hier unterstützten Elemente sind dieselben wie die Zeilenspalten, wobei das Präfix LeavePeriods_LeavePeriod_ entfernt wurde.

    INSERT INTO LeaveApplications (EmployeeID, LeaveTypeID, Title, StartDate, EndDate, LeavePeriodAggregate) VALUES (
      'XXXXX-XXXXX-XXXXX-XXXXX',
      'YYYYY-YYYYY-YYYYY-YYYYY',
      'Visit relatives',
      '2021-01-01',
      '2021-01-07',
      '<LeavePeriod>
        <NumberOfUnits>8</NumberOfUnits>
       </LeavePeriod>
       <LeavePeriod>
        <NumberOfUnits>32</NumberOfUnits>
       </LeavePeriod>'
    )
    
  2. Sie können einen neuen Zeitraum in ein vorhandenes Objekt einfügen, indem Sie die von Xero generierte Kennung des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einem vorhandenen Urlaubsantrag einen Zeitraum hinzu:

    INSERT INTO LeaveApplications (LeaveApplicationID, LeavePeriods_LeavePeriod_NumberOfUnits) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY', 32)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. DELETE

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String True Die Urlaubsposition kombiniert mit der eindeutigen Xero-Kennung des Urlaubsantrags.
LeaveApplicationID String True Die eindeutige Kennung des Urlaubsantrags. Dieses Feld wird von Xero zugewiesen.
EmployeeID String Falsch Die Xero Kennung für den Lohn- und Gehaltsabrechnungsmitarbeiter.
LeaveTypeID String Falsch Die Xero Kennung für den Abwesenheitstyp.
Title String Falsch Der Titel des Urlaubs (maximale Länge = 50).
StartDate String Falsch Beginndatum des Urlaubs (JJJJ-MM-TT).
EndDate String Falsch Enddatum des Urlaubs (JJJJ-MM-TT).
Description String Falsch Die Beschreibung des Urlaubs (max. Länge = 200).
LeavePeriodAggregate String Falsch Wird verwendet, um LeavePeriod-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
LeavePeriods_LeavePeriod_PayPeriodStartDate String Falsch Der Beginn der Lohnperiode, ab der der Urlaub genommen wird
LeavePeriods_LeavePeriod_PayPeriodEndDate String Falsch Das Ende des Lohnzeitraums, aus dem der Urlaub genommen wird
LeavePeriods_LeavePeriod_LeavePeriodStatus String Falsch Entweder GEPLANT oder VERARBEITET
LeavePeriods_LeavePeriod_NumberOfUnits String Falsch Menge des in diesem Abrechnungszeitraum konsumierten Urlaubs
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnartikelAbzüge

PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
DeductionTypeID [KEY] String True Die eindeutige Kennung des PayItem. Dieses Feld wird von Xero zugewiesen.
Name String Falsch Name der Abzugsart.
DeductionCategory String Falsch Kategorie des Abzugs.
AccountCode String Falsch Vom Kunden definierter alphanumerischer Kontocode.
ReducesTax String Falsch Zeigt an, dass es sich um einen Abzug vor Steuern handelt.
ReducesSuper String Falsch Gibt an, dass hierdurch Ihre Verpflichtung zur Zahlung eines Superannuation-Garantie-Beitrags reduziert wird.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am PayItem-Datensatz.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
PayItemsEarnings

PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
EarningsRateID [KEY] String True Die eindeutige Kennung des PayItem. Dieses Feld wird von Xero zugewiesen.
Name String Falsch Name der Verdienstquote.
DisplayName String Falsch Anzeigename des Verdienstsatzes, wie er auf den Gehaltsabrechnungen erscheint.
AccountCode String Falsch Vom Kunden definierter alphanumerischer Kontocode.
TypeOfUnits String Falsch Art der Einheiten, die zur Erfassung von Erträgen verwendet werden.
IsExemptFromTax String Falsch Sie sollten diesen Wert nur festlegen, wenn Sie sicher sind, dass eine Zahlung von der PAYG-Einbehaltung befreit ist.
IsExemptFromSuper String Falsch Einzelheiten darüber, welche Zahlungen vom SGC befreit sind, finden Sie auf der ATO-Website.
IsReportableAsW1 Bool Falsch Ob der Verdienstsatz der W1-Quellensteuer unterliegt.
EarningsType String Falsch Die Art des Lohnpostenverdienstes. Gültige Werte sind FIXED, ORDINARYTIMEEARNINGS, OVERATIMEEARNINGS, ALLOWANCE und LUMPSUMD.
AllowanceType String Falsch Wenn „EarningsType“ „ALLOWANCE“ lautet, wird hier angegeben, wofür die Zulage gezahlt wird.
AllowanceCategory String Falsch Bestimmt die Art der Zulage, wenn AllowanceType OTHER ist.
RateType String Falsch Der Zinssatztyp des Verdienstes. Gültige Werte sind FIXEDAMOUNT, MULTIPLE, RATEPERUNIT
RatePerUnit String Falsch Nur anwendbar, wenn RateType RATEPERUNIT ist.
Multiplier Double Falsch Dies ist der Multiplikator, der zur Berechnung des Satzes pro Einheit verwendet wird, basierend auf der normalen Verdienstart des Mitarbeiters. Nur anwendbar, wenn RateType MULTIPLE ist.
AccrueLeave String Falsch Gibt an, dass dieser Verdienstsatz für den Urlaub anfallen soll. Nur anwendbar, wenn RateType MULTIPLE ist.
Amount String Falsch Optionsbetrag für FIXEDAMOUNT RateType EarningsRate.
CurrentRecord Bool Falsch Ob der Ertragssatz weiterhin verwendet werden darf.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am PayItem-Datensatz.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
BezahlenArtikelVerlassen

PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
LeaveTypeID [KEY] String True Die eindeutige Kennung des PayItem. Dieses Feld wird von Xero zugewiesen.
Name String Falsch Name der Abwesenheitsart.
TypeOfUnits String Falsch Der Einheitentyp, mit dem Urlaubsansprüche normalerweise verfolgt werden.
IsPaidLeave String Falsch Legen Sie dies fest, um anzugeben, dass ein Mitarbeiter für diese Art von Urlaub bezahlt wird.
ShowOnPaySlip String Falsch Legen Sie dies fest, wenn auf den Gehaltsabrechnungen Ihrer Mitarbeiter ein Saldo für diese Urlaubsart angezeigt werden soll.
NormalEntitlement String Falsch Die Anzahl der Einheiten, auf die der Mitarbeiter jedes Jahr Anspruch hat.
LeaveLoadingRate String Falsch Geben Sie hier einen Betrag ein, wenn Ihr Unternehmen Ihren Mitarbeitern bei Urlaub einen zusätzlichen Prozentsatz zum normalen Verdienst zahlt (normalerweise 17,5 %).
UpdatedDateUTC String Falsch Das Datum und die Uhrzeit der letzten Aktualisierung dieser Zeile.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
PayItemsRückerstattungen

PayItems für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
ReimbursementTypeID [KEY] String True Die eindeutige Kennung des PayItem. Dieses Feld wird von Xero zugewiesen.
Name String Falsch Name der Erstattungsart.
AccountCode String Falsch Vom Kunden definierter alphanumerischer Kontocode.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am PayItem-Datensatz.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Lohn- und Gehaltskalender

Abfragen, Einfügen und Aktualisieren von Lohn- und Gehaltskalendern für eine Xero-Organisation.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
PayrollCalendarID [KEY] String True Die eindeutige Kennung des PaySchedule. Dieses Feld wird von Xero zugewiesen.
Name String Falsch Der Name des Gehaltskalenders.
CalendarType String Falsch Der Typ des Lohnkalenders.
StartDate String Falsch Das Startdatum der nächsten Lohnperiode.
PaymentDate String Falsch Das Datum, an dem die Mitarbeiter für die kommende Lohnperiode bezahlt werden.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Lohnläufe

Gehaltsabrechnungen für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
PayRunID [KEY] String True Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
PayrollCalendarID String Falsch Der Status der Gehaltsabrechnung. Gültige Werte sind AKTIV und GELÖSCHT.
PayRunPeriodStartDate String Falsch Zeitraumbeginn für den PayRun.
PayRunPeriodEndDate String Falsch Periodenenddatum für den PayRun.
PayRunStatus String Falsch Der Status der Gehaltsabrechnung.
PaymentDate String Falsch Zahlungsdatum für den PayRun.
PayslipMessage String Falsch Lohnabrechnungsmeldung für den PayRun.
Wages Decimal Falsch Gesamtlohn für den PayRun.
Deductions Decimal Falsch Gesamtabzug für den PayRun.
Tax Decimal Falsch Gesamtsteuer für den PayRun.
Super Decimal Falsch Gesamtsuper für den PayRun.
Reimbursement Decimal Falsch Gesamte Erstattung für den PayRun.
NetPay Decimal Falsch Gesamtnettolohn für den PayRun.
UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung des Gehaltsdatensatzes.
Payslip String Falsch Die Lohnabrechnung für diesen Lohnlauf im XML-Format.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnabrechnungAbzüge

Abfrage von Lohnabzugspositionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Abzugszeile hinzu.

INSERT INTO PaySlipDeductions (PayslipID, DeductionLine_DeductionTypeId, DeductionLine_CalculationType, DeductionLine_Amount) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', 'b78b5ddd-6a20-4992-8e77-1243a122265d', 'FIXEDAMOUNT', 50)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Vorgänge werden gegenüber der Xero API als zwei Vorgänge gezählt. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipDeductions SET DeductionLine_Amount=5 WHERE Id='2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID ein, um Lohnabzugszeilen zu löschen.

DELETE FROM PaySlipDeductions WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
DeductionLine_DeductionTypeId String Falsch Die eindeutige Kennung der Abzugsart der Position
DeductionLine_CalculationType String Falsch Wie der Abzug auf das Einkommen angewendet wird, entweder VOR STEUERN, NACH STEUERN oder FESTBETRAG
DeductionLine_Amount Decimal Falsch Der Gesamtbetrag des Abzugs
DeductionLine_Percentage Double Falsch Der Prozentsatz des Einkommens, auf den dieser Abzug angewendet wird
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnabrechnungEinkünfte

Abfrage der Gehaltsabrechnungspositionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Verdienstzeile hinzu.

INSERT INTO PaySlipEarnings (PaySlipID, EarningsLine_EarningsRateId, EarningsLine_RatePerUnit, EarningsLine_NumberOfUnits) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', 'fc394b8d-ff2e-4f10-992b-2a41390ad2c4', 4, 20)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipEarnings SET EarningsLine_RatePerUnit = 5 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID ein, um die Lohnabrechnungszeilen zu löschen.

DELETE FROM PaySlipEarnings WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
EarningsLine_EarningsRateId String Falsch Die eindeutige Kennung der Ertragsrate der Position
EarningsLine_RatePerUnit Decimal Falsch Der Lohn der Position pro Zeiteinheit (z.B. Stunden)
EarningsLine_NumberOfUnits Double Falsch Die Anzahl der Zeiteinheiten in dieser Position (z. B. Stunden)
EarningsLine_FixedAmount Decimal Falsch Der Gesamtverdienst in dieser Position. Erscheint nur, wenn der Tariftyp FEST ist.
EarningsLine_LumpSumETaxYear String Falsch Das Steuerjahr, das für diese Einkünfte gilt. Wird nur angezeigt, wenn der Einkunftstyp PAUSCHAL ist.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
GehaltsabrechnungUrlaubsabgrenzung

Abfrage von Gehaltsabrechnungsposten für Urlaubsansprüche einer Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Zeile für die Urlaubsrückstellung hinzu.

INSERT INTO PaySlipLeaveAccrual (PaySlipID, LeaveAccrualLine_LeaveTypeId, LeaveAccrualLine_NumberOfUnits, LeaveAccrualLine_AutoCalculate) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', '73f37030-b1ed-45fe-b7a2-f704a3a28ad4', 8, false)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipLeaveAccrual SET LeaveAccrualLine_NumberOfUnits = 5 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID zum Löschen von Urlaubsrückstellungszeilen an.

DELETE FROM PaySlipLeaveAccrual WHERE Id = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
PaySlipReimbursements
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
LeaveAccrualLine_LeaveTypeId String Falsch Die eindeutige Kennung der Abwesenheitsart der Position
LeaveAccrualLine_NumberOfUnits Double Falsch Wie viel Urlaub wurde hinzugefügt
LeaveAccrualLine_AutoCalculate String Falsch Ob Urlaub automatisch berechnet werden soll oder nicht
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnabrechnungRückerstattungen

Abfrage von Lohnrückerstattungspositionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Erstattungszeile hinzu.

INSERT INTO PaySlipReimbursements (PaySlipID, ReimbursementLine_ReimbursementTypeId, ReimbursementLine_Amount) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', '3432120f-4d83-4bc2-8b5d-5a116838229e', 5)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipReimbursements SET ReimbursementLine_Amount = 6 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID zum Löschen von Lohnabrechnungsrückerstattungszeilen an.

DELETE FROM PaySlipReimbursements WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
ReimbursementLine_ReimbursementTypeId String Falsch Die eindeutige Kennung der Erstattungsart der Position
ReimbursementLine_Description String Falsch Eine Beschreibung der Erstattung
ReimbursementLine_ExpenseAccount String Falsch Das Konto, von dem die Rückerstattung erfolgt
ReimbursementLine_Amount Decimal Falsch Die Höhe der Erstattung
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
GehaltsabrechnungAltersvorsorge

Abfrage von Gehaltsabrechnungspositionen für die Altersversorgung einer Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Rentenzeile hinzu.

INSERT INTO PaySlipSuperannuations (PayslipID, SuperannuationLine_SuperMembershipId, SuperannuationLine_ContributionType, SuperannuationLine_CalculationType, SuperannuationLine_Amount, SuperannuationLine_ExpenseAccountCode, SuperannuationLine_LiabilityAccountCode, SuperannuationLine_Percentage, SuperannuationLine_PaymentDateForThisPeriod) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', '045ef1ba-1399-4b49-b324-8c8b70d05607', 'SGC', 'PERCENTAGEOFEARNINGS', 9, '478', '826', 9.0, '2023-06-28')

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Vorgänge werden gegenüber der Xero API als zwei Vorgänge gezählt. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipSuperannuations SET SuperannuationLine_Percentage = 10 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID an, um die Zeilen der Gehaltsabrechnung für die Altersversorgung zu löschen.

DELETE FROM PaySlipSuperannuations WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
SuperannuationLine_SuperMembershipId String Falsch Die eindeutige Kennung des Superfonds der Einzelposition.
SuperannuationLine_ContributionType String Falsch Der Super-Beitragstyp
SuperannuationLine_CalculationType String Falsch Der Super-Berechnungstyp
SuperannuationLine_MinimumMonthlyEarnings Decimal Falsch Das super Mindestmonatseinkommen
SuperannuationLine_ExpenseAccountCode String Falsch Der Super-Ausgabenkontocode
SuperannuationLine_LiabilityAccountCode String Falsch Der Super-Haftpflichtkontocode
SuperannuationLine_PaymentDateForThisPeriod Date Falsch Das Super-Zahlungsdatum für diesen Zeitraum
SuperannuationLine_Percentage Double Falsch Der Superprozentsatz
SuperannuationLine_Amount Decimal Falsch Der Superbetrag
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnabrechnungSteuern

Abfrage der Lohnsteuerpositionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Steuerzeile hinzu.

INSERT INTO PaySlipTaxes (PayslipID, TaxLine_Amount) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', 5)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipTaxes SET TaxLine_Amount = 10 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID zum Löschen der Lohnsteuerzeilen ein.

DELETE FROM PaySlipTaxes WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
TaxLine_TaxTypeName String Falsch Der Name der Steuerart der Position
TaxLine_Description String Falsch Die Beschreibung der Steuer
TaxLine_Amount Decimal Falsch Der Steuerbetrag
TaxLine_LiabilityAccount String Falsch Das zur Zahlung der Steuer verwendete Verbindlichkeitskonto
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
LohnabrechnungArbeitszeiterfassungVerdienst

Abfrage von Gehaltsabrechnungs-, Arbeitszeitnachweis- und Verdienstpositionen für eine Xero-Organisation.

Tabellenspezifische Informationen

Diese Tabelle unterstützt serverseitig die folgenden Operatoren: =,IN

EINFÜGEN

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Der Connector fügt der Gehaltsabrechnung eine neue Zeile mit den Stundenverdiensten hinzu.

INSERT INTO PaySlipTimesheetEarnings (PayslipID, TimesheetEarningsLine_EarningsRateId, TimesheetEarningsLine_RatePerUnit, TimesheetEarningsLine_NumberOfUnits) VALUES ('ea5aaaa7-c330-41d8-bfae-98ddc1f37680', 'c8602c7c-5f6f-433e-b7a7-bcbbd8386818', 32, 10)

AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Vorgänge werden gegenüber der Xero API als zwei Vorgänge gezählt. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren.

UPDATE PaySlipTimesheetEarnings SET TimesheetEarningsLine_NumberOfUnits = 5 WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'

LÖSCHEN

Geben Sie die ID an, um die Verdienstzeilen im Arbeitszeitnachweis zu löschen.

DELETE FROM PaySlipTimesheetEarnings WHERE ID = '2|ea5aaaa7-c330-41d8-bfae-98ddc1f37680'
Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String Wahr Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Falsch Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String True Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
TimesheetEarningsLine_EarningsRateId String Falsch Die eindeutige Kennung der Ertragsrate der Position
TimesheetEarningsLine_RatePerUnit Decimal Falsch Der Preis der Position pro Zeiteinheit (z. B. Stunden)
TimesheetEarningsLine_NumberOfUnits Decimal Falsch Die Anzahl der Zeiteinheiten (z. B. Stunden)
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
SuperFunds

Abfragen, Einfügen und Aktualisieren von Payroll Super Funds in einer Xero-Organisation.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
SuperFundID [KEY] String Wahr Xero Kennung.
Type String Richtig REGULIERT oder SMSF.
Name String Falsch Name des Superfonds.
ABN String Falsch ABN des Super Fund.
USI String Falsch USI des regulierten Super Fund.
BSB String Falsch BSB des Self Managed Super Fund.
AccountNumber String Falsch Die Kontonummer für den selbstverwalteten Superfonds.
AccountName String Falsch Der Kontoname für den selbstverwalteten Superfonds.
ElectronicServiceAddress String Falsch Die elektronische Serviceadresse für den selbstverwalteten Superfonds.
EmployerNumber String Falsch Manche Kassen weisen jedem Arbeitgeber eine eindeutige Nummer zu.
SPIN String Falsch Der SPIN des regulierten SuperFund (veraltet).
UpdatedDateUTC String Falsch Das Datum der letzten Aktualisierung dieser Zeile
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Arbeitszeitnachweise

Abfragen, Einfügen und Aktualisieren von Arbeitszeittabellen für eine Xero-Organisation.

Tabellenspezifische Informationen

Mit der Tabelle „Zeiterfassung“ können Sie Zeiterfassungszeilen für eine Xero-Organisation AUSWÄHLEN, EINFÜGEN und AKTUALISIEREN. Die ID-Spalte wird vom Connector generiert. Der Wert dieses Felds kombiniert den Index der Position mit der eindeutigen, von Xero generierten TimesheetID.

WÄHLEN

Die Xero API ermöglicht umfangreiches Filtern und Sortieren. Sie können WHERE- und ORDER BY-Klauseln in einer Abfrage definieren, um die Ergebnisse mithilfe beliebiger Spalten, die keine Einzelposten sind, zu filtern und zu sortieren.

Hinweis: Die Xero API unterstützt keine Filterung von Einzelposten oder Journalzeilen. INSERT

Um eine einzelne Zeile einzufügen, legen Sie die erforderlichen Felder fest. Ein neues Tabellenobjekt wird als einzelner Eintrag erstellt. Um ein neues Arbeitszeitblatt einzufügen, sind die Felder EmployeeID, StartDate und EndDate erforderlich.

Neben dem Einfügen einer einzelnen Zeile bieten Einzelpostentabellen zwei weitere Möglichkeiten zum Einfügen in eine Tabelle.

  1. Sie können mithilfe von XML-Aggregaten ein neues Objekt mit mehreren Positionen einfügen. Die hier unterstützten Elemente sind dieselben wie die Zeilenspalten, wobei das Präfix Line_ entfernt wurde, außer bei der Angabe von Einheitenzahlen. Weitere Einzelheiten finden Sie in der Xero Dokumentation zum Timesheets-API Endpoint.

    INSERT INTO Timesheets (EmployeeID, StartDate, EndDate, TimesheetLineAggregate) VALUES (
      'XXXXX-XXXXX-XXXXX-XXXXX',
      '2021-01-01',
      '2021-01-07',
      '<TimesheetLine>
        <EarningsRateID>YYYYY-YYYYY-YYYYY-YYYYY</EarningsRateID>
        <NumberOfUnits>
         <NumberOfUnit>8</NumberOfUnit>
         <NumberOfUnit>7</NumberOfUnit>
         <NumberOfUnit>8</NumberOfUnit>
         <NumberOfUnit>6</NumberOfUnit>
         <NumberOfUnit>9</NumberOfUnit>
       </TimesheetLine>
       <TimesheetLine>
        <EarningsRateID>ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ</EarningsRateID>
        ...
       </TimesheetLine>'
    )
    
  2. Sie können eine neue Position in ein vorhandenes Objekt einfügen, indem Sie die von Xero generierte Kennung des vorhandenen Datensatzes angeben. So fügen Sie beispielsweise einer vorhandenen Arbeitszeittabelle eine Position hinzu:

    INSERT INTO Timesheets (TimesheetID, Line_EarningsRateID, Line_NumberOfUnits_NumberOfUnit1, Line_NumberOfUnits_NumberOfUnit2, ...) VALUES ('XXXXX-XXXXX-XXXXX-XXXXX', 'YYYYY-YYYYY-YYYYY-YYYYY', 8, 7, ...)
    

Hinweis: Das Einfügen in vorhandene Datensätze zählt als zwei Vorgänge gegenüber der Xero API. Einer ist erforderlich, um den vorhandenen Datensatz abzurufen, und ein anderer, um den Datensatz mit neuen Daten zu aktualisieren. AKTUALISIEREN

Sie können jedes Feld aktualisieren, das nicht schreibgeschützt ist.

Hinweis: UPDATE-Operationen werden gegenüber der Xero API als zwei Operationen gezählt. Eine ist erforderlich, um den vorhandenen Datensatz abzurufen, und eine andere, um den Datensatz mit neuen Daten zu aktualisieren. DELETE

Die Xero API bietet nur eingeschränkte Unterstützung für das Löschen von Objekten. Um Objekte zu löschen, müssen Sie ihren Status auf einen entsprechenden Wert aktualisieren.

Die für dieses Feld anwendbaren Werte können statusabhängig sein. Beispielsweise kann der Status von Rechnungen nur dann auf GELÖSCHT gesetzt werden, wenn der Rechnungsstatus aktuell ENTWURF oder ÜBERMITTELT lautet.

Spalten
Name Typ Nur-Lesen Filterbar Beschreibung
Id [KEY] String True Die Arbeitszeitnachweis-Einzelposition kombiniert mit der eindeutigen Xero-Kennung des Arbeitszeitnachweises.
TimesheetID String True Die eindeutige Kennung des Arbeitszeitnachweises. Dieses Feld wird von Xero zugewiesen.
EmployeeID String Falsch Die Xero Kennung für einen Mitarbeiter.
StartDate Date Falsch Beginndatum der Periode.
EndDate Date Falsch Enddatum des Zeitraums.
Status String Falsch Der Statuscode für das Arbeitszeitblatt. Die gültigen Werte sind ENTWURF, VERARBEITET und GENEHMIGT.
Hours Double Falsch Gesamtstundenzahl im Stundenzettel.
Line_EarningsRateId String Falsch Die Xero Kennung für einen Verdiensttyp.
Line_TrackingItemId String Falsch Die Xero-Kennung für eine Tracking-Kategorie TrackingOptionID. Die TrackingOptionID muss zu der TrackingCategory gehören, die unter Gehaltsabrechnungseinstellungen als TimesheetCategories ausgewählt wurde.
Line_WorkLocationId String Falsch Die Xero Kennung für einen Arbeitsort.
Line_NumberOfUnits_NumberOfUnit1 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit2 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit3 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit4 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit5 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit6 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_NumberOfUnits_NumberOfUnit7 String Falsch Anzahl der Einheiten einer Zeiterfassungszeile.
Line_UpdatedDateUTC Datetime True Zeitstempel der letzten Änderung am Arbeitszeitnachweiszeilendatensatz.
TimesheetLineAggregate String Falsch Wird verwendet, um TimesheetLine-Zeilen mithilfe von XML-Werten zu definieren. Sollte nur bei INSERT bereitgestellt werden.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

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.

Xero Connector-Ansichten
Name Beschreibung
EmployeeBankAccounts Abfrage der Bankkonten eines Mitarbeiters in einer Xero-Organisation.
EmployeePayTemplateDeductions Abfrage der Abzugszeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation.
EmployeePayTemplateEarnings Abfrage der Verdienstzeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation.
EmployeePayTemplateLeave Abfrage der Urlaubszeilen der Lohnvorlage für einen Mitarbeiter in einer Xero-Organisation.
EmployeePayTemplateReimbursements Abfrage der Erstattungszeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation.
EmployeePayTemplateSupers Abfrage der Superzeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation.
LeaveBalances Abfrage des Urlaubsguthabens eines Mitarbeiters in einer Xero-Organisation.
PaySlipLeaveEarnings Abfrage von Gehaltsabrechnungsposten für Urlaubsverdienste für eine Xero-Organisation.
PaySlips Gehaltsabrechnungen für eine Xero-Organisation abfragen.
Tenants Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.
MitarbeiterBankKonten

Fragen Sie die Bankkonten eines Mitarbeiters in einer Xero-Organisation ab.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
StatementText String Der Text, der auf dem Kontoauszug des Mitarbeiters erscheint
AccountName String Der Name des Kontos
BSB String Die BSB-Nummer des Kontos
AccountNumber String Die Kontonummer
Remainder Boolean Wenn der restliche Teil des Gehalts des Mitarbeiters auf dieses Konto überwiesen werden soll
Amount Decimal Ein fester Betrag des Gehalts des Mitarbeiters, der auf dieses Konto überwiesen wird
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
MitarbeiterBezahlungVorlageAbzüge

Fragen Sie die Abzugszeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation ab.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
DeductionTypeID String Die ID des für diese Position verwendeten Abzugssatzes
CalculationType String Einer von FIXEDAMOUNT, PRETAX oder POSTTAX
Percentage Decimal Der Abzugssatz für Vorsteuer- oder Nachsteuerabzüge
Amount Decimal Der Abzugsbetrag für FIXEDAMOUNT-Abzüge
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
MitarbeiterBezahlungVorlageVerdienst

Fragen Sie die Verdienstzeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation ab.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
EarningsRateID String Die ID des für diese Position verwendeten Ertragssatzes
CalculationType String Eines von USEEARNINGSRATE, ENTEREARNINGSRATE oder ANNUALSALARY
NumberOfUnitsPerWeek Int Wie viele Stunden der Mitarbeiter pro Woche arbeitet. Wird nur für das JAHRESGEHALT verwendet.
AnnualSalary Decimal Das Jahresgehalt des Arbeitnehmers
RatePerUnit Decimal Der Satz pro Einheit der Ertragslinie
NormalNumberOfUnits Decimal Die Zeiteinheiten in der Ergebniszeile
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
MitarbeiterBezahlungVorlageUrlaub

Abfrage der Urlaubszeilen der Lohnvorlage für einen Mitarbeiter in einer Xero-Organisation.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
LeaveTypeID String Die ID der Abwesenheitsart, die auf diese Zeile angewendet wird
CalculationType String Eines von FIXEDAMOUNTEACHPERIOD, ENTIRERATEINPAYTEMPLATE oder BASEDONORDINARYEARNINGS
AnnualNumberOfUnits Decimal Die jährlich angesparten Urlaubsstunden
FullTimeNumberOfUnitsPerPeriod Decimal Die pro Abrechnungsperiode anfallenden Urlaubsstunden
NumberOfUnits Decimal Eine feste Urlaubszeit
EntitlementFinalPayPayoutType String Eines von NOTPAIDOUT oder PAIDOUT
EmploymentTerminationPaymentType String Eines von O oder R, nur gültig, wenn EntitlementFinalPayPaoutType PAIDOUT ist
IncludeSuperannuationGuaranteeContribution Boolean Ob ETP-Urlaubsverdienste dem SGC unterliegen
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
EmployeePayTemplateRückerstattungen

Fragen Sie die Erstattungszeilen der Lohnvorlage für einen Mitarbeiter in einer Xero-Organisation ab.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
ReimbursementTypeID String Die ID der auf diese Zeile angewendeten Erstattungsart
Description String Die Beschreibung der Erstattungszeile
Amount Decimal Der Betrag der Erstattungszeile
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Mitarbeiter-GehaltsvorlageSupers

Abfrage der Superzeilen der Gehaltsvorlage für einen Mitarbeiter in einer Xero-Organisation.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID String Die ID des Mitarbeiters. Dieses Feld wird von Xero zugewiesen.
SuperMembershipID String Die ID des Pensionsfonds, zu dem diese Zeile beiträgt
ContributionType String Eines von SGC, SALARYSACRIFICE, EMPLOYERADDITIONAL oder EMPLOYEE
CalculationType String Eines von FIXEDAMOUNT, PERCENTAGEOFEARNINGS oder STATUTORY
ExpenseAccountCode String Der Code für das von dieser Zeile verwendete Aufwandskonto
LiabilityAccountCode String Der Code für das von dieser Zeile verwendete Aufwandskonto
MinimumMonthlyEarnings Decimal Der Mindestverdienst, den der Arbeitnehmer im Monat verdienen muss, damit diese Klausel wirksam wird
Percentage Decimal Der Prozentsatz der Superlinie
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Urlaubsguthaben

Fragen Sie den Urlaubssaldo eines Mitarbeiters in einer Xero-Organisation ab.

Spalten
Name Typ Filterbar Beschreibung
EmployeeID [KEY] String ID des Mitarbeiters
LeaveTypeID [KEY] String ID der Abwesenheitsart
LeaveName String Der Name der Abwesenheitsart
NumberOfUnits Double Der Restbetrag des verfügbaren Urlaubs
TypeOfUnits String Die Art der Einheiten
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
LohnabrechnungUrlaubVerdienst

Abfrage von Gehaltsabrechnungsposten für Urlaubsverdienste für eine Xero-Organisation.

Spalten
Name Typ Filterbar Beschreibung
Id [KEY] String Die Verdienstposition kombiniert mit der eindeutigen Xero Kennung der Gehaltsabrechnung
PayslipID String Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
LeaveEarningsLine_EarningsRateId String Die eindeutige Kennung der Ertragsrate der Position
LeaveEarningsLine_RatePerUnit Decimal Der Stundenlohn der Position
LeaveEarningsLine_NumberOfUnits Double Die Anzahl der Stunden in dieser Position
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Lohnabrechnungen

Gehaltsabrechnungen für eine Xero-Organisation abfragen.

Spalten
Name Typ Filterbar Beschreibung
PayRunID String Die ID des Lohnlaufs, der die Lohnabrechnungen enthält
PayslipID [KEY] String Die eindeutige Kennung der Gehaltsabrechnung. Dieses Feld wird von Xero zugewiesen.
EmployeeID String Die eindeutige Kennung des Mitarbeiters auf der Gehaltsabrechnung.
FirstName String Der Vorname des Mitarbeiters.
LastName String Der Vorname des Mitarbeiters.
EmployeeGroup String Der Name der Gruppe, zu der der Mitarbeiter gehört.
LastEdited Datetime Wann diese Gehaltsabrechnung zuletzt geändert wurde.
Wages Decimal Der Gesamtlohn ist in der Lohnabrechnung enthalten.
Deductions Decimal Die gesamten Abzüge sind in der Lohnabrechnung enthalten.
NetPay Decimal Der gesamte Nettolohn ist in der Lohnsteuererklärung enthalten.
Tax Decimal Die gesamte gezahlte Steuer ist in der Gehaltsabrechnung enthalten.
Super Decimal Die gesamte Altersversorgung ist in der Lohnsteuerbemessungsgrundlage enthalten.
Reimbursements Decimal Die gesamte Erstattung ist in der Gehaltsabrechnung enthalten.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Mieter

Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.

Spalten
Name Typ Filterbar Beschreibung
TenantId [KEY] String Eine eindeutige Kennung für den Mandanten.
Name String Der Name der Organisation oder Praxis
Type String Ob der Mieter eine Organisation oder eine Praxis ist
IsActive Boolean Ob die Verbindung derzeit diesen Mandanten verwendet

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Xero Connector
Name Beschreibung
GetLimitInfo Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.
GetOAuthAccessToken Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung bei Xero verwendet werden soll.
GetOAuthAuthorizationURL Ruft die OAuth-Autorisierungs URL für die Authentifizierung bei verschiedenen Xero Diensten ab.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.
RevokeTenant Trennt den Mandanten von dieser Anwendung. Der Benutzer muss sich das nächste Mal erneut autorisieren, wenn er diese Anwendung mit diesem Mandanten verbindet.
SwitchTenant Ändert den Mandanten, von dem diese Verbindung Daten abruft.
GetLimitInfo

Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.

Verfahrensspezifische Informationen

Dieses Verfahren meldet Informationen, die der Connector nach jeder API Anforderung zwischenspeichert. Wenn bei einer Verbindung keine Anforderungen an einen Mandanten gestellt wurden, meldet dieses Verfahren 0 Zeilen. Andernfalls wird LastModified Das Feld meldet, wann die Informationen in der Zeile zum letzten Mal aktualisiert wurden.

Wenn der letzte Änderungszeitpunkt zu lange her ist, als dass Ihre Anwendung ihn verwenden könnte, kann diese Tabelle durch Ausführen einer Abfrage aktualisiert werden. Die Abfrage muss mindestens eine Zeile lesen, um sicherzustellen, dass eine API Anforderung ausgelöst wird:

SELECT * FROM PayRuns LIMIT 1

Spalten des Ergebnissatzes

Name Typ Beschreibung
TenantId String ID des Mandanten, für den das Limit gilt. Die Ausgabe enthält eine Zeile für jeden Mandanten, der während der Verbindung abgefragt wurde. Normalerweise gibt es nur eine.
AppRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 10.000). Dies gilt für alle Mandanten.
MinuteRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 60). Dies gilt nur für diesen Mandanten.
DayRemaining Integer Die Anzahl der API Aufrufe, die die aktuelle OAuth-App heute hat (max. 5000). Dies gilt nur für diesen Mandanten.
RetryAfter Integer Die empfohlene Wiederholungszeit, wenn einer der oben genannten Grenzwerte beim letzten API Aufruf an den Mandanten 0 war.
LastModified Datetime Wann diese Informationen zuletzt aktualisiert wurden. Die Werte in dieser Tabelle werden nur bei API -Aufrufen aktualisiert, daher kann dieser Wert älter sein als der aktuelle Zeitpunkt.
GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung mit Xero verwendet werden soll.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String True Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB.
AuthToken String Falsch Das von GetOAuthAuthorizationUrl zurückgegebene Authentifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich.
AuthKey String Falsch Der von GetOAuthAuthorizationUrl zurückgegebene AuthKey. Nur für den Web-Auth-Modus erforderlich.
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der im Developer Portal registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/').
Verifier String Falsch Das von Xero zurückgegebene Prüftoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
PKCEVerifier String Falsch Der von GetOAuthAuthorizationURL zurückgegebene PKCEVerifier.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthAccessTokenSecret String Das von Xero zurückgegebene Authentifizierungstoken-Geheimnis. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL zur Authentifizierung bei verschiedenen Xero Diensten ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Dieser Wert ist nur erforderlich, wenn Sie Ihre eigene App registriert haben. Diese URL muss dieselbe Domäne haben wie die im Xero Developer Portal angegebene OAuth-Rückrufdomäne.
Scope String Falsch Die durch Leerzeichen getrennte Liste der Bereiche, die Sie von Xero anfordern. Standardmäßig werden alle Bereiche angefordert.
State String Falsch Ein Statustoken, das in die Autorisierungs URL aufgenommen werden soll. Standardmäßig nicht enthalten.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL zum Abschließen der Benutzerauthentifizierung.
AuthToken String Ein Token, das als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
AuthKey String Ein Schlüssel, der als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
PKCEVerifier String Ein zufälliger Wert, der als Eingabe für GetOAuthAccessToken im PKCE-Flow verwendet wird.
Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
Mieter widerrufen

Trennt den Mandanten von dieser Anwendung. Der Benutzer muss die Autorisierung erneut durchführen, wenn er diese Anwendung das nächste Mal mit diesem Mandanten verbindet.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des zu widerrufenden Mandanten, wie in der Mandantenansicht angegeben
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ob die Verbindung erfolgreich widerrufen wurde
Mieter wechseln

Ändert den Mandanten, von dem diese Verbindung Daten abruft.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des Mandanten, an den eine Verbindung hergestellt werden soll. Wenn leer, wird der aktuelle Mandant nicht geändert.
Ergebnissatzspalten
Name Typ Beschreibung
ActiveTenant String Die ID des Mandanten, der derzeit aktiv ist.

Dateidatenmodell

Der Xero-Connector modelliert die Xero Files API als relationale Tabellen und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen sind in diesem Abschnitt dokumentiert. Sie können die SupportEnhancedSQL-Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen

in der Datenquelle verwendet werden.

Tabellen

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

Xero Connector-Tabellen
Name Beschreibung
Associations Abfragen, Einfügen und Löschen von Zuordnungen für eine Xero-Organisation.
Files Dateien für eine Xero-Organisation abfragen, aktualisieren und löschen.
Folders Ordner für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.
Verbände

Abfragen, Einfügen und Löschen von Zuordnungen für eine Xero-Organisation.

Tabellenspezifische Informationen

Um eine Assoziation zu erstellen, muss alles außer der ID und dem Objekttyp angegeben werden:

INSERT INTO Associations (FileId, ObjectId, ObjectGroup)
VALUES ('2bf7b85c-7ed8-47b4-8559-d83f8f5f9b9c', '4819be2c-b3b7-43a2-80fe-ef479ad25351', 'Invoice')

Verknüpfungen können nach dem Einfügen nicht mehr geändert werden. Wenn Sie eine Verknüpfung aktualisieren müssen, müssen Sie sie löschen und neu erstellen.

Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Falsch Eine eindeutige Kombination aus der verknüpften Datei und dem verknüpften Objekt
FileId String False Die FileId der Datei, die verknüpft wird
ObjectId String Falsch Die Kennung des Objekts, das verknüpft wird mit
ObjectGroup String Falsch Die Buchhaltungseinheit, der das Objekt zugeordnet werden soll
ObjectType String True Eine spezifischere Kategorie, zu der das Objekt gehört
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Dateien

Abfragen, Aktualisieren und Löschen von Dateien für eine Xero-Organisation.

Tabellenspezifische Informationen

Wenn Sie mit Dateiinhalten interagieren müssen (hoch- oder herunterladen), lesen Sie bitte die gespeicherten Prozeduren für Dateien.

Spalten
Name Typ Nur Lesen Beschreibung
FileId [KEY] String True Die eindeutige, von Xero generierte ID der Datei
Name String Falsch Der Name der Datei
FolderId String False Die FolderId des Ordners, der die Datei enthält
MimeType String True Welche Art von Daten die Datei enthält
Size Int True Die Größe der Datei in Bytes
User_Id String True Die eindeutige ID des Benutzers, der die Datei hochgeladen hat
User_Name String True Der Benutzername des Benutzers, der die Datei hochgeladen hat
User_FirstName String True Der Vorname des Benutzers, der die Datei hochgeladen hat
User_LastName String True Der Nachname des Benutzers, der die Datei hochgeladen hat
User_FullName String True Der vollständige Name des Benutzers, der die Datei hochgeladen hat
Created Datetime Wahr Wann die Datei zum ersten Mal hochgeladen wurde
Updated Datetime True Wann die Dateimetadaten zuletzt geändert wurden
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Ordner

Ordner für eine Xero-Organisation abfragen, einfügen, aktualisieren und löschen.

Tabellenspezifische Informationen

Beim Erstellen eines Ordners muss ein Name angegeben werden:

INSERT INTO Folders (Name) VALUE ('Legal Documents')
Spalten
Name Typ Nur Lesen Beschreibung
FolderId [KEY] String True Die eindeutige, von Xero generierte ID des Ordners
Name String Falsch Der Name des Ordners
FileCount Integer True Wie viele Dateien sind im Ordner vorhanden
IsInbox Boolean True Gibt an, ob dieser Ordner der Posteingang ist. Der Posteingang wird automatisch von Xero erstellt und kann nicht geändert oder gelöscht werden.
Email String True Die Email-Adresse, die Dateien akzeptiert und in diesen Ordner hochlädt. Nur für den Posteingang verfügbar.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

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.

Xero Connector-Ansichten
Name Beschreibung
Tenants Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.
Mieter

Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.

Spalten
Name Typ Beschreibung
TenantId [KEY] String Eine eindeutige Kennung für den Mandanten.
Name String Der Name der Organisation oder Praxis
Type String Ob der Mieter eine Organisation oder eine Praxis ist
IsActive Boolean Ob die Verbindung derzeit diesen Mandanten verwendet

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Xero Connector
Name Beschreibung
DownloadFile Lädt eine Datei vom Xero Files-Dienst herunter
GetLimitInfo Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.
GetOAuthAccessToken Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung bei Xero verwendet werden soll.
GetOAuthAuthorizationURL Ruft die OAuth-Autorisierungs URL für die Authentifizierung bei verschiedenen Xero Diensten ab.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.
RevokeTenant Trennt den Mandanten von dieser Anwendung. Der Benutzer muss sich das nächste Mal erneut autorisieren, wenn er diese Anwendung mit diesem Mandanten verbindet.
SwitchTenant Ändert den Mandanten, von dem diese Verbindung Daten abruft.
UploadFile Lädt eine Datei zum Xero Files-Dienst hoch
Datei herunterladen

Lädt eine Datei vom Xero Files-Dienst herunter

Verfahrensspezifische Informationen

Es gibt zwei verschiedene Möglichkeiten, eine Datei herunterzuladen. Wenn Sie einen DownloadPath angeben, wird die Datei heruntergeladen und ihr Inhalt an diesem Speicherort gespeichert:

EXECUTE DownloadFile @FileID = '...', @DownloadPath = 'c:/my/xero/files/form.docx'

Wenn Sie keinen DownloadPath angeben, wird der Inhalt der Datei base64-codiert und in der FileData-Ausgabe zurückgegeben:

EXECUTE DownloadFile @FileID = '...'

Eingabe

Name Typ Erforderlich Beschreibung
FileId String True Die ID der herunterzuladenden Datei
DownloadPath String Falsch Wohin die heruntergeladene Datei geschrieben werden soll.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

Spalten des Ergebnissatzes

Name Typ Beschreibung
FileData String Wenn DownloadPath und FileStream nicht angegeben sind, enthält dies den Base64-codierten Inhalt der Datei.
Success String Dieser Parameter legt fest, ob der Operation erfolgreich war oder nicht.
GetLimitInfo

Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.

Verfahrensspezifische Informationen

Dieses Verfahren meldet Informationen, die der Connector nach jeder API Anforderung zwischenspeichert. Wenn bei einer Verbindung keine Anforderungen an einen Mandanten gestellt wurden, meldet dieses Verfahren 0 Zeilen. Andernfalls wird LastModified Das Feld meldet, wann die Informationen in der Zeile zum letzten Mal aktualisiert wurden.

Wenn der letzte Änderungszeitpunkt zu lange her ist, als dass Ihre Anwendung ihn verwenden könnte, kann diese Tabelle durch Ausführen einer Abfrage aktualisiert werden. Die Abfrage muss mindestens eine Zeile lesen, um sicherzustellen, dass eine API Anforderung ausgelöst wird:

SELECT * FROM Files LIMIT 1

Spalten des Ergebnissatzes

Name Typ Beschreibung
TenantId String ID des Mandanten, für den das Limit gilt. Die Ausgabe enthält eine Zeile für jeden Mandanten, der während der Verbindung abgefragt wurde. Normalerweise gibt es nur eine.
AppRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 10.000). Dies gilt für alle Mandanten.
MinuteRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 60). Dies gilt nur für diesen Mandanten.
DayRemaining Integer Die Anzahl der API Aufrufe, die die aktuelle OAuth-App heute hat (max. 5000). Dies gilt nur für diesen Mandanten.
RetryAfter Integer Die empfohlene Wiederholungszeit, wenn einer der oben genannten Grenzwerte beim letzten API Aufruf an den Mandanten 0 war.
LastModified Datetime Wann diese Informationen zuletzt aktualisiert wurden. Die Werte in dieser Tabelle werden nur bei API -Aufrufen aktualisiert, daher kann dieser Wert älter sein als der aktuelle Zeitpunkt.
GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung mit Xero verwendet werden soll.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String True Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB.
AuthToken String Falsch Das von GetOAuthAuthorizationUrl zurückgegebene Authentifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich.
AuthKey String Falsch Der von GetOAuthAuthorizationUrl zurückgegebene AuthKey. Nur für den Web-Auth-Modus erforderlich.
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der im Developer Portal registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/').
Verifier String Falsch Das von Xero zurückgegebene Prüftoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
PKCEVerifier String Falsch Der von GetOAuthAuthorizationURL zurückgegebene PKCEVerifier.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthAccessTokenSecret String Das von Xero zurückgegebene Authentifizierungstoken-Geheimnis. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL zur Authentifizierung bei verschiedenen Xero Diensten ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Dieser Wert ist nur erforderlich, wenn Sie Ihre eigene App registriert haben. Diese URL muss dieselbe Domäne haben wie die im Xero Developer Portal angegebene OAuth-Rückrufdomäne.
Scope String Falsch Die durch Leerzeichen getrennte Liste der Bereiche, die Sie von Xero anfordern. Standardmäßig werden alle Bereiche angefordert.
State String Falsch Ein Statustoken, das in die Autorisierungs URL aufgenommen werden soll. Standardmäßig nicht enthalten.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL zum Abschließen der Benutzerauthentifizierung.
AuthToken String Ein Token, das als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
AuthKey String Ein Schlüssel, der als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
PKCEVerifier String Ein zufälliger Wert, der als Eingabe für GetOAuthAccessToken im PKCE-Flow verwendet wird.
Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
Mieter widerrufen

Trennt den Mandanten von dieser Anwendung. Der Benutzer muss die Autorisierung erneut durchführen, wenn er diese Anwendung das nächste Mal mit diesem Mandanten verbindet.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des zu widerrufenden Mandanten, wie in der Mandantenansicht angegeben
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ob die Verbindung erfolgreich widerrufen wurde
Mieter wechseln

Ändert den Mandanten, von dem diese Verbindung Daten abruft.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des Mandanten, an den eine Verbindung hergestellt werden soll. Wenn leer, wird der aktuelle Mandant nicht geändert.
Ergebnissatzspalten
Name Typ Beschreibung
ActiveTenant String Die ID des Mandanten, der derzeit aktiv ist.
Datei hochladen

Lädt eine Datei zum Xero Files-Dienst hoch

Verfahrensspezifische Informationen

Es gibt verschiedene Möglichkeiten, eine Datei hochzuladen:

1. Geben Sie den vollständigen Pfad zu einer lokalen Datei an. Dadurch wird eine Datei mit demselben Namen und Inhalt in Xero erstellt:

EXECUTE UploadFile @Filename = 'c:/my/xero/files/form.docx

2. Geben Sie den vollständigen Pfad zu einer lokalen Datei sowie einen Namen an. Dadurch wird der Inhalt der Datei trotzdem hochgeladen, Sie können jedoch den Namen der Datei in Xero ändern:

EXECUTE UploadFile @Filename = 'c:/my/xero/files/form.docx', @Name = 'legal-form.docx'
  1. Geben Sie den Inhalt der Datei in Base64 und den Namen an, den die Datei in Xero erhalten soll:
EXECUTE UploadFile @Name = hello.txt', @FileData = 'SGVsbG8sIFdvcmxkIQo='

Darüber hinaus können Sie einen ContentType angeben, um den Typ zu überschreiben, den Xero bei der Klassifizierung der Datei verwenden soll. Beachten Sie jedoch, dass Xero nur eine begrenzte Anzahl von MIME-Typen unterstützt, die im Xero Central-Artikel zur Verwaltung der Dateibibliothek aufgeführt sind.

Eingang

Name Typ Erforderlich Beschreibung
Name String Falsch Der Name, den die Datei beim Hochladen erhält. Wenn nicht angegeben, wird er aus dem Dateinamen bestimmt.
ContentType String Falsch Dieser Parameter legt den MIME-Typ für das Dokument explizit fest. Wenn er leer gelassen wird, wird er automatisch bestimmt.
FileData String Falsch Base-64 codierte Daten für die Datei. Erforderlich, wenn Dateiname und FileStream nicht definiert sind.
Filename String Falsch Der vollständige Pfad (einschließlich Dateiname) der hochzuladenden Datei. Erforderlich, wenn FileData und FileStream nicht definiert sind.
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

Ergebnissatzspalten

Name Typ Beschreibung
Success String Ob der Operation erfolgreich war oder nicht.
FileId String Die eindeutige, von Xero generierte ID der Datei
Name String Der Name der hochgeladenen Datei
FolderId String Die Ordner-ID, in die die Datei hochgeladen wurde
MimeType String Welche Art von Daten die hochgeladene Datei enthält
Size Int Die Größe der hochgeladenen Datei in Bytes
User_Id String Die eindeutige ID des Benutzers, der die Datei hochgeladen hat
User_Name String Der Benutzername des Benutzers, der die Datei hochgeladen hat
User_FirstName String Der Vorname des Benutzers, der die Datei hochgeladen hat
User_LastName String Der Nachname des Benutzers, der die Datei hochgeladen hat
User_FullName String Der vollständige Name des Benutzers, der die Datei hochgeladen hat
Created Datetime Wann die Datei zum ersten Mal hochgeladen wurde
Updated Datetime Wann die Datei zuletzt geändert wurde

Datenmodell für Anlagevermögen

Der Xero-Connector modelliert die Xero Assets API als relationale Tabellen, Ansichten und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen sind in diesem Abschnitt dokumentiert. Sie können die SupportEnhancedSQL-Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Ansichten

Ansichten beschreibt die verfügbaren Ansichten.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen

in der Datenquelle verwendet werden.

Tabellen

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

Xero Connector-Tabellen
Name Beschreibung
Assets Assets für eine Xero Organisation abfragen, einfügen und aktualisieren.
AssetTypes Asset-Typen für eine Xero Organisation abfragen, einfügen und aktualisieren.
Vermögenswerte

Abfragen, Einfügen und Aktualisieren von Assets für eine Xero-Organisation.

Tabellenspezifische Informationen

Assets erstellen

Ein Asset kann nur mit einem AssetName und einer AssetNumber erstellt werden. Dadurch wird ein Asset-Entwurf mit leeren Einstellungen für Kaufdatum und -preis, Seriennummer und alle anderen Werte erstellt.

INSERT INTO Assets (AssetName, AssetNumber) VALUES ('Corporate van', 'FA-0042')

Aktualisieren von Vermögenswerten

Wie bei Vermögensarten kann der Wert eines Vermögenswerts entweder mit einer Abschreibungsrate oder einer geschätzten Lebensdauer gemessen werden. Sobald diese Werte festgelegt wurden, können Sie nur zwischen den beiden wechseln, indem Sie den anderen auf Null setzen:

UPDATE Assets
SET BookDepreciationSetting_DepreciationRate = 0.12,
    BookDepreciationSetting_EffectiveLifeYears = null
WHERE AssetId = '46c7f1f4-7cdb-47d3-8772-2796d0b83e87'

Registrieren von Vermögenswerten

Um ein Asset vom Entwurfsstatus in den registrierten Status zu verschieben, müssen Sie ihm die folgenden Eigenschaften zuweisen:

  1. AssetTypeId
  2. Kaufdatum
  3. Kaufpreis
  4. BookDepreciationSetting_DepreciationStartDate
  5. BookDepreciationSetting_AveragingMethod
  6. Entweder ein BookDepreciationSetting_DepreciationRate oder ein BookDepreciationSetting_EffectiveLifeYears

Anschließend können Sie das Feld AssetStatus auf den Wert „Registriert“ aktualisieren.

Veräußerung von Vermögenswerten

Die Veräußerung von Vermögenswerten wird durch die API nicht unterstützt.

Spalten
Name Typ Nur Lesen Beschreibung
AssetId [KEY] String True Die eindeutige, von Xero generierte ID des Assets
AssetName String Falsch Der Name des Assets
AssetNumber String Falsch Ein eindeutiger Code für das Asset
AssetStatus String Falsch Entweder ENTWURF, REGISTRIERT oder ENTSORGT
Description String Falsch Frei formulierte Kommentare zum Asset
PurchaseDate Date Falsch Wann wurde das Anlagegut gekauft
PurchasePrice Decimal Falsch Wie viel hat das Anlagegut beim Kauf gekostet
DisposalDate Date Falsch Wann wurde das Anlagegut gekauft
DisposalPrice Decimal Falsch Zu welchem Preis der Vermögenswert veräußert wurde
WarrantyExpiryDate Date Falsch Wenn die Garantie des Vermögenswerts erlischt
SerialNumber String Falsch Die Seriennummer des Vermögenswerts
AssetTypeId String Falsch Die ID des Typs dieses Assets
BookDepreciationSetting_DepreciationMethod String Falsch Entweder NoDepreciation, StraightLine, DiminishingValue100, DiminishingValue150, DiminishingValue200 oder FullDepreciation
BookDepreciationSetting_AveragingMethod String Falsch Entweder ActualDays oder FullMonth
BookDepreciationSetting_DepreciationRate Double Falsch Die Abschreibungsrate in Prozent
BookDepreciationSetting_EffectiveLifeYears Int Falsch Die Nutzungsdauer des Vermögenswerts in Jahren
BookDepreciationSetting_DepreciationCalculationMethod String Falsch Entweder Rate, Leben oder Keine
BookDepreciationDetail_CurrentCapitalGain Decimal Falsch Sobald der Vermögenswert veräußert wird, ist dies der Verkaufspreis abzüglich des Kaufpreises
BookDepreciationDetail_CurrentGainLoss Decimal Falsch Sobald der Vermögenswert veräußert wird, ist dies das Minimum aus Verkaufs- und Kaufpreis abzüglich des aktuellen Buchwerts
BookDepreciationDetail_DepreciationStartDate Date Falsch Wann die Abschreibung wirksam wird
BookDepreciationDetail_CostLimit Decimal Falsch Der Wert des abzuschreibenden Vermögenswerts, wenn dieser geringer ist als die Anschaffungskosten
BookDepreciationDetail_ResidualValue Decimal Falsch Der Wert des Vermögenswerts, nachdem er vollständig abgeschrieben wurde
BookDepreciationDetail_PriorAccumDepreciationAmount Decimal Falsch Alle Abschreibungen vor dem aktuellen Geschäftsjahr
BookDepreciationDetail_CurrentAccumDepreciationAmount Decimal Falsch Sämtliche im laufenden Geschäftsjahr anfallenden Abschreibungen
CanRollBack Boolean True Ob die Abschreibung des Vermögenswerts rückgängig gemacht werden kann
AccountingBookValue Decimal Wahr Der Buchwert des Vermögenswerts
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Asset-Typen

Abfragen, Einfügen und Aktualisieren von Asset-Typen für eine Xero-Organisation.

Tabellenspezifische Informationen

Erstellen von Asset-Typen

Ein Asset-Typ kann mit einer von zwei Methoden zur Berechnung der Abschreibung erstellt werden. Die erste Methode basiert auf einem festen Prozentsatz (in diesem Beispiel 0,15 %):

INSERT INTO AssetTypes (
  AssetTypeName,
  FixedAssetAccountId,
  DepreciationExpenseAccountId,
  AccumulatedDepreciationAccountId,
  BookDepreciationSetting_DepreciationMethod,
  BookDepreciationSetting_AveragingMethod,
  BookDepreciationSetting_DepreciationRate
)
VALUES (
  'Vehicles',
  '8e968d1a-5e25-4dad-b6f9-c8f4d72c0cac',
  '20b36596-3d1d-4789-9f08-50c92d19d522',
  '2a9bb066-3398-40e8-a953-caaabed2b7a7',
  'StraightLine',
  'FullMonth',
  0.15
)

Alternativ könnten Sie einen Anlagetyp erstellen, der entsprechend der effektiven Nutzungsdauer abgeschrieben wird:

INSERT INTO AssetTypes (
  AssetTypeName,
  FixedAssetAccountId,
  DepreciationExpenseAccountId,
  AccumulatedDepreciationAccountId,
  BookDepreciationSetting_DepreciationMethod,
  BookDepreciationSetting_AveragingMethod,
  BookDepreciationSetting_EffectiveLifeYears
)
VALUES (
  'Vehicles',
  '8e968d1a-5e25-4dad-b6f9-c8f4d72c0cac',
  '20b36596-3d1d-4789-9f08-50c92d19d522',
  '2a9bb066-3398-40e8-a953-caaabed2b7a7',
  'StraightLine',
  'FullMonth',
  12
)

Aktualisieren von Asset-Typen

Da ein Asset-Typ entweder eine Abschreibungsrate oder eine effektive Nutzungsdauer verwenden muss, müssen Sie ein Feld auf NULL setzen, wenn Sie den Asset-Typ ändern möchten, um das andere zu verwenden. Um beispielsweise von einer effektiven Nutzungsdauer zu einer Abschreibungsrate zu wechseln:

UPDATE AssetTypes
SET BookDepreciationSetting_DepreciationRate = 0.09,
    BookDepreciationSetting_EffectiveLifeYears = null
WHERE AssetTypeId = 'bf28b6ca-3cc6-4591-ac5a-2c1115f04b4b'
Spalten
Name Typ Nur Lesen Beschreibung
AssetTypeId [KEY] String True Die eindeutige, von Xero generierte ID des Asset-Typs
AssetTypeName String Falsch Der Name des Asset-Typs
FixedAssetAccountId String Falsch Das für Vermögenswerte dieser Art verwendete Anlagekonto
DepreciationExpenseAccountId String Falsch Das Aufwandskonto, das bei der Wertminderung von Vermögenswerten dieses Typs verwendet wird
AccumulatedDepreciationAccountId String Falsch Das für die kumulierte Abschreibung von Vermögenswerten dieses Typs verwendete Konto
BookDepreciationSetting_DepreciationMethod String Falsch Entweder NoDepreciation, StraightLine, DiminishingValue100, DiminishingValue150, DiminishingValue200 oder FullDepreciation
BookDepreciationSetting_AveragingMethod String Falsch Entweder ActualDays oder FullMonth
BookDepreciationSetting_DepreciationRate Decimal Falsch Die Abschreibungsrate in Prozent
BookDepreciationSetting_EffectiveLifeYears Int Falsch Die Nutzungsdauer des Vermögenswerts in Jahren
BookDepreciationSetting_DepreciationCalculationMethod String Wahr Entweder Rate, Leben oder Keines
Locks Int True Die Anzahl der Assets, die diesen Asset-Typ verwenden
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

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.

Xero Connector-Ansichten
Name Beschreibung
Settings Asset-Einstellungen für eine Xero-Organisation abfragen.
Tenants Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.
Einstellungen

Fragen Sie die Asset-Einstellungen für eine Xero-Organisation ab.

Spalten
Name Typ Beschreibung
AssetNumberPrefix String Das zum Generieren von Anlagennummern verwendete Präfix
AssetNumberSequence String Die nächste verfügbare Anlagennummer
AssetStartDate Date Das Datum, an dem Xero mit der Berechnung der Abschreibung für Anlagevermögen begonnen hat
LastDepreciationDate Date Das letzte Abschreibungsdatum
DefaultGainOnDisposalAccountId String Das Standardkonto, auf das Gewinne gebucht werden
DefaultLossOnDisposalAccountId String Das Standardkonto, auf das Verluste gebucht werden
DefaultCapitalGainOnDisposalAccountId String Das Standardkonto, auf das Kapitalgewinne gebucht werden
OptInForTax Boolean
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll
Mieter

Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.

Spalten
Name Typ Beschreibung
TenantId [KEY] String Eine eindeutige Kennung für den Mandanten.
Name String Der Name der Organisation oder Praxis
Type String Ob der Mieter eine Organisation oder eine Praxis ist
IsActive Boolean Ob die Verbindung derzeit diesen Mandanten verwendet

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Xero Connector
Name Beschreibung
GetLimitInfo Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.
GetOAuthAccessToken Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung bei Xero verwendet werden soll.
GetOAuthAuthorizationURL Ruft die OAuth-Autorisierungs URL für die Authentifizierung bei verschiedenen Xero Diensten ab.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.
RevokeTenant Trennt den Mandanten von dieser Anwendung. Der Benutzer muss sich das nächste Mal erneut autorisieren, wenn er diese Anwendung mit diesem Mandanten verbindet.
SwitchTenant Ändert den Mandanten, von dem diese Verbindung Daten abruft.
GetLimitInfo

Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.

Verfahrensspezifische Informationen

Dieses Verfahren meldet Informationen, die der Connector nach jeder API Anforderung zwischenspeichert. Wenn bei einer Verbindung keine Anforderungen an einen Mandanten gestellt wurden, meldet dieses Verfahren 0 Zeilen. Andernfalls wird LastModified Das Feld meldet, wann die Informationen in der Zeile zum letzten Mal aktualisiert wurden.

Wenn der letzte Änderungszeitpunkt zu lange her ist, als dass Ihre Anwendung ihn verwenden könnte, kann diese Tabelle durch Ausführen einer Abfrage aktualisiert werden. Die Abfrage muss mindestens eine Zeile lesen, um sicherzustellen, dass eine API Anforderung ausgelöst wird:

SELECT * FROM AssetTypes LIMIT 1

Spalten des Ergebnissatzes

Name Typ Beschreibung
TenantId String ID des Mandanten, für den das Limit gilt. Die Ausgabe enthält eine Zeile für jeden Mandanten, der während der Verbindung abgefragt wurde. Normalerweise gibt es nur eine.
AppRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 10.000). Dies gilt für alle Mandanten.
MinuteRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 60). Dies gilt nur für diesen Mandanten.
DayRemaining Integer Die Anzahl der API Aufrufe, die die aktuelle OAuth-App heute hat (max. 5000). Dies gilt nur für diesen Mandanten.
RetryAfter Integer Die empfohlene Wiederholungszeit, wenn einer der oben genannten Grenzwerte beim letzten API Aufruf an den Mandanten 0 war.
LastModified Datetime Wann diese Informationen zuletzt aktualisiert wurden. Die Werte in dieser Tabelle werden nur bei API -Aufrufen aktualisiert, daher kann dieser Wert älter sein als der aktuelle Zeitpunkt.
GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung mit Xero verwendet werden soll.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String True Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB.
AuthToken String Falsch Das von GetOAuthAuthorizationUrl zurückgegebene Authentifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich.
AuthKey String Falsch Der von GetOAuthAuthorizationUrl zurückgegebene AuthKey. Nur für den Web-Auth-Modus erforderlich.
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der im Developer Portal registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/').
Verifier String Falsch Das von Xero zurückgegebene Prüftoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
PKCEVerifier String Falsch Der von GetOAuthAuthorizationURL zurückgegebene PKCEVerifier.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthAccessTokenSecret String Das von Xero zurückgegebene Authentifizierungstoken-Geheimnis. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL zur Authentifizierung bei verschiedenen Xero Diensten ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Dieser Wert ist nur erforderlich, wenn Sie Ihre eigene App registriert haben. Diese URL muss dieselbe Domäne haben wie die im Xero Developer Portal angegebene OAuth-Rückrufdomäne.
Scope String Falsch Die durch Leerzeichen getrennte Liste der Bereiche, die Sie von Xero anfordern. Standardmäßig werden alle Bereiche angefordert.
State String Falsch Ein Statustoken, das in die Autorisierungs URL aufgenommen werden soll. Standardmäßig nicht enthalten.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL zum Abschließen der Benutzerauthentifizierung.
AuthToken String Ein Token, das als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
AuthKey String Ein Schlüssel, der als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
PKCEVerifier String Ein zufälliger Wert, der als Eingabe für GetOAuthAccessToken im PKCE-Flow verwendet wird.
Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
Mieter widerrufen

Trennt den Mandanten von dieser Anwendung. Der Benutzer muss die Autorisierung erneut durchführen, wenn er diese Anwendung das nächste Mal mit diesem Mandanten verbindet.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des zu widerrufenden Mieters, wie in der Mieteransicht angegeben
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ob die Verbindung erfolgreich widerrufen wurde
Mieter wechseln

Ändert den Mandanten, von dem diese Verbindung Daten abruft.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des Mandanten, an den eine Verbindung hergestellt werden soll. Wenn leer, wird der aktuelle Mandant nicht geändert.
Ergebnissatzspalten
Name Typ Beschreibung
ActiveTenant String Die ID des Mandanten, der derzeit aktiv ist.

Projekte-Datenmodell

Der Xero-Connector modelliert die Xero Projects API als relationale Tabellen, Ansichten und gespeicherte Prozeduren. API Einschränkungen und-Anforderungen sind in diesem Abschnitt dokumentiert. Sie können die SupportEnhancedSQL Funktion, standardmäßig eingestellt, um die meisten dieser Einschränkungen zu umgehen.

Tabellen

Tabellen beschreibt die verfügbaren Tabellen.

Ansichten

Ansichten beschreibt die verfügbaren Ansichten.

Gespeicherte Prozeduren

Gespeicherte Prozeduren sind funktionsähnliche Schnittstellen zur Datenquelle. Sie können zum Suchen, Aktualisieren und Ändern von Informationen

in der Datenquelle verwendet werden.

Tabellen

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

Xero Connector-Tabellen
Name Beschreibung
Projects Projekte für eine Xero-Organisation abfragen, einfügen und aktualisieren.
Tasks Aufgaben für ein Xero Projekt abfragen, einfügen, aktualisieren und löschen.
Time Zeiteinträge für ein Xero Projekt abfragen, einfügen, aktualisieren und löschen.
Projekte

Projekte für eine Xero-Organisation abfragen, einfügen und aktualisieren.

Tabellenspezifische Informationen

Projekte erstellen

Ein Projekt muss mit einem Namen und einer Kontakt-ID erstellt werden. Die Kontakt-ID stammt aus der Spalte „Kontakt-ID“ in der Tabelle „Kontakte“ der Accounting API. Es kann auch ein EstimateValue angegeben werden, um die anfängliche Schätzung für das Projekt festzulegen:

INSERT INTO Projects (Name, ContactId, Deadline, EstimateValue) VALUES ('Construct Parking Lot', '1c5ac798-1e31-4c09-82ac-4781261ff20a', '2025-01-01', 250000)

Projekte aktualisieren

Sobald ein Projekt erstellt wurde, können nur dessen Frist und geschätzter Wert aktualisiert werden:

UPDATE Projects SET Deadline = '2022-01-01', EstimateValue = 150000 WHERE ProjectId = '1de78bad-5a81-4cb8-ab53-5a1a3bc73b29'
Spalten
Name Typ Nur Lesen Beschreibung
ProjectId [KEY] String True Die eindeutige Xero Kennung des Projekts.
ContactId String Falsch Die ID des Kontakts, für den das Projekt erstellt wurde
Name String Falsch Der Name des Projekts.
CurrencyCode String True Die im Projekt verwendete Währung.
MinutesLogged Int True Die Gesamtzahl der Minuten, die für alle Aufgaben im Projekt protokolliert wurden
TotalTaskAmountValue Decimal True Der gesamte Ist-Betrag jeder Projektaufgabe
TotalTaskAmountCurrency String True Die Währung von TotalTaskAmountValue
TotalExpenseAmountValue Decimal Wahr Der tatsächliche Gesamtbetrag aller Projektausgaben
TotalExpenseAmountCurrency String True Die Währung von TotalExpenseAmountValue
MinutesToBeInvoiced Int True Die Gesamtminuten aller Aufgaben, die nicht in Rechnung gestellt wurden
TaskAmountToBeInvoicedValue Decimal True Der gesamte AmountToBeInvoicedValue für jede Aufgabe im Projekt
TaskAmountToBeInvoicedCurrency String True Die Währung des TaskAmountToBeInvoicedValue
TaskAmountInvoicedValue Decimal True Der gesamte AmountInvoicedValue für jede Aufgabe im Projekt
TaskAmountInvoicedCurrency String True Die Währung des TaskAmountInvoicedValue
ExpenseAmountToBeInvoicedValue Decimal True Die Summe aller Ausgaben im Projekt, die nicht in Rechnung gestellt wurden
ExpenseAmountToBeInvoicedCurrency String True Die Währung des ExpenseAmountToBeInvoicedValue
ExpenseAmountInvoicedValue Decimal True Die Summe aller in Rechnung gestellten Ausgaben des Projekts
ExpenseAmountInvoicedCurrency String True Die Währung des ExpenseAmountInvoicedValue
ProjectAmountInvoicedValue Decimal True Der Gesamtbetrag, der für das gesamte Projekt in Rechnung gestellt wurde
ProjectAmountInvoicedCurrency String True Die Währung des ProjectAmountInvoicedValue
DepositValue Decimal Stimmt Die Anzahlung für das Projekt
DepositCurrency String True Die Währung des DepositValue
DepositAppliedValue Decimal True Der Betrag der Anzahlung, der den Projektrechnungen gutgeschrieben wurde.
DepositAppliedCurrency String True Die Währung des DepositAppliedValue
CreditNoteValue Decimal True Die Gesamtsumme der Gutschriften im Projekt
CreditNoteCurrency String True Die Währung des CreditNoteValue
Deadline Date Falsch Die Währung des CreditNoteValue
TotalInvoicedValue Decimal Wahr Der Gesamtbetrag, der dem Projekt über alle Kategorien hinweg in Rechnung gestellt wurde
TotalInvoicedCurrency String True Die Währung des TotalInvoicedValue
TotalToBeInvoicedValue Decimal True Der Gesamtbetrag für das Projekt, der noch in Rechnung gestellt werden muss, über alle Kategorien hinweg
TotalToBeInvoicedCurrency String True Die Währung des TotalToBeInvoicedValue
EstimateValue Decimal Falsch Der Kostenvoranschlag für das Projekt
EstimateCurrency String True Die Währung des EstimateValue
Status String Wahr Entweder IN PROGRESS oder GESCHLOSSEN
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Aufgaben

Aufgaben für ein Xero-Projekt abfragen, einfügen, aktualisieren und löschen.

Tabellenspezifische Informationen

Aufgaben erstellen

Eine Aufgabe muss mit einer Projekt-ID, einem Namen, einer Kurswährung, einem Kurswert und einem Gebührentyp erstellt werden. Die Projekt-ID und die Kurswährung müssen aus dem Projekt stammen (Projekt-ID bzw. Währungscode). Der Gebührentyp bestimmt, wie der Kurswert auf die Kosten des Projekts angewendet wird:

  • TIME berechnet dem Projekt stündlich den Betrag in RateValue.
  • FIXED berechnet dem Projekt einmalig den Betrag in RateValue.
  • NON_CHARGEABLE berechnet das Projekt nicht. RateValue muss auf 0 gesetzt werden.

EstimateMinutes kann auch angegeben werden, um die Zeitschätzung für die Aufgabe festzulegen:

INSERT INTO Tasks (ProjectId, Name, RateCurrency, RateValue, ChargeType, EstimateMinutes) VALUES ('1de78bad-5a81-4cb8-ab53-5a1a3bc73b29', 'Pave Sidewalks', 'USD', 25000, 'FIXED', 1000)

Aufgaben aktualisieren

Sobald eine Aufgabe erstellt wurde, können ihre RateCurrency, RateValue, ChargeType oder EstimateMinutes aktualisiert werden:

UPDATE Tasks SET RateValue = 250, ChargeType = 'TIME', EstimateMinutes = 2000 WHERE ID = '1de78bad-5a81-4cb8-ab53-5a1a3bc73b29/d15810a1-9324-4765-a357-80d160a0b87c'

Aufgaben löschen

Aufgaben können auch durch Angabe ihrer ID gelöscht werden:

DELETE FROM Tasks WHERE ID = '1de78bad-5a81-4cb8-ab53-5a1a3bc73b29/d15810a1-9324-4765-a357-80d160a0b87c'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Falsch Eine eindeutige Kombination aus Projekt- und Aufgabenkennungen
TaskId String True Die eindeutige Xero Kennung der Aufgabe.
ProjectId String Falsch Die ID des Projekts
Name String Falsch Der Name der Aufgabe
ChargeType String Falsch Eines von ZEIT, FEST oder NICHT_KOSTENPFLICHTIG
RateValue Decimal Falsch Der für die Aufgabe in Rechnung gestellte Stundensatz
RateCurrency String Falsch Die Währung des RateValue
EstimateMinutes Int Falsch Die geschätzte Anzahl von Minuten zum Abschließen der Aufgabe
TotalMinutes Int True Die Gesamtanzahl der für die Aufgabe protokollierten Minuten
TotalAmountValue Decimal True Der Gesamtwert der Aufgabe, TotalMinutes multipliziert mit RateValue
TotalAmountCurrency String True Die Währung des TotalAmountValue
MinutesToBeInvoiced Int Wahr Die für diese Aufgabe aufgewendeten Minuten, die noch nicht in Rechnung gestellt wurden
MinutesInvoiced Int Wahr Die für diese Aufgabe in Rechnung gestellten Minuten
NonChargeableMinutes Int Wahr Die Minuten für diese Aufgabe, die nicht berechnet werden können
AmountToBeInvoicedValue Decimal True Der Gesamtwert der Aufgabe, der nicht in Rechnung gestellt wurde, MinutesToBeInvoiced multipliziert mit RateValue
AmountToBeInvoicedCurrency String True Die Währung des AmountToBeInvoicedValue
AmountInvoicedValue Decimal True Der Gesamtwert der in Rechnung gestellten Aufgabe, MinutesInvoiced multipliziert mit RateValue
AmountInvoicedCurrency String True Die Währung des Rechnungsbetrags
Status String Wahr Eines von AKTIV, RECHNUNGSGESTELLT oder GESPERRT
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten
Zeit

Zeiteinträge für ein Xero Projekt abfragen, einfügen, aktualisieren und löschen.

Tabellenspezifische Informationen

Zeit erstellen

Eine Zeit muss mit einer Projekt-ID, einer Aufgaben-ID, einer Benutzer-ID, einem Datum und einer Dauer erstellt werden. Eine optionale Beschreibung kann ebenfalls angegeben werden:

INSERT INTO Time (ProjectId, TaskId, UserId, Date, Duration, Description) VALUES ('1de78bad-5a81-4cb8-ab53-5a1a3bc73b29', 'd15810a1-9324-4765-a357-80d160a0b87c', '312b124b-f33f-4cfe-a831-20eb290610d6', '2019-10-01', 250, 'Paved northwest section')

Zeit aktualisieren

Sobald eine Zeit erstellt wurde, können Benutzer-ID, Datum, Dauer oder Beschreibung aktualisiert werden:

UPDATE Time SET Date = '2019-11-01', Duration = 350 WHERE ID = '1de78bad-5a81-4cb8-ab53-5a1a3bc73b29/cb53829a-31ca-4760-a2a7-5a2a46e67cfb'

Zeit löschen

Zeiten können auch durch Angabe ihrer ID gelöscht werden:

DELETE FROM Time WHERE ID = '1de78bad-5a81-4cb8-ab53-5a1a3bc73b29/cb53829a-31ca-4760-a2a7-5a2a46e67cfb'
Spalten
Name Typ Nur Lesen Beschreibung
Id [KEY] String Falsch Eine eindeutige Kombination aus Projekt- und Zeiteintragskennungen
TimeEntryId String True Die eindeutige Xero Kennung des Zeiteintrags.
UserId String False Die ID des Benutzers, der den Zeiteintrag protokolliert hat
ProjectId String Falsch Die ID des Projekts, zu dem die Aufgabe gehört
TaskId String Falsch Die ID der Aufgabe, für die die Zeit protokolliert wird
Date Date Falsch Der Tag, für den die Zeit erfasst wurde
DateEntered Datetime True Wann der Zeiteintrag erstellt wurde
Duration Int Falsch Wann der Zeiteintrag erstellt wurde
Description String Falsch Die Beschreibung des Zeiteintrags
Status String Wahr Eines von AKTIV, GESPERRT oder RECHNUNGSGESTELLT
TenantId String Falsch Die ID des Abfrage Mandanten anstelle des Verbindungsmandanten

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.

Xero Connector-Ansichten
Name Beschreibung
Tenants Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.
Users Projektbenutzer für eine Xero-Organisation abfragen.
Mieter

Fragen Sie die Liste der mit Ihrem Xero Konto verbundenen Organisationen ab.

Spalten
Name Typ Beschreibung
TenantId [KEY] String Eine eindeutige Kennung für den Mandanten.
Name String Der Name der Organisation oder Praxis
Type String Ob der Mieter eine Organisation oder eine Praxis ist
IsActive Boolean Ob die Verbindung derzeit diesen Mandanten verwendet
Benutzer

Projektbenutzer für eine Xero Organisation abfragen.

Spalten
Name Typ Beschreibung
UserId [KEY] String Die eindeutige Xero Kennung des Benutzers.
Name String Der vollständige Name des Benutzers.
Email String Die Email des Benutzers.
TenantId String Die ID des Mandanten, der anstelle des Verbindungsmandanten Abfrage werden soll

Gespeicherte Prozeduren

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

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

Gespeicherte Prozeduren für den Xero Connector
Name Beschreibung
GetLimitInfo Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.
GetOAuthAccessToken Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung bei Xero verwendet werden soll.
GetOAuthAuthorizationURL Ruft die OAuth-Autorisierungs URL für die Authentifizierung bei verschiedenen Xero Diensten ab.
RefreshOAuthAccessToken Aktualisiert den OAuth-Zugriffstoken, der für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.
RevokeTenant Trennt den Mandanten von dieser Anwendung. Der Benutzer muss sich das nächste Mal erneut autorisieren, wenn er diese Anwendung mit diesem Mandanten verbindet.
SwitchTenant Ändert den Mandanten, von dem diese Verbindung Daten abruft.
GetLimitInfo

Ruft Grenzwertinformationen ab. Verwenden Sie diese gespeicherte Prozedur, um Ihre API Grenzwerte zu überwachen, während Sie Aufrufe an einen Mandanten tätigen.

Verfahrensspezifische Informationen

Dieses Verfahren meldet Informationen, die der Connector nach jeder API Anforderung zwischenspeichert. Wenn bei einer Verbindung keine Anforderungen an einen Mandanten gestellt wurden, meldet dieses Verfahren 0 Zeilen. Andernfalls wird LastModified Das Feld meldet, wann die Informationen in der Zeile zum letzten Mal aktualisiert wurden.

Wenn der letzte Änderungszeitpunkt zu lange her ist, als dass Ihre Anwendung ihn verwenden könnte, kann diese Tabelle durch Ausführen einer Abfrage aktualisiert werden. Die Abfrage muss mindestens eine Zeile lesen, um sicherzustellen, dass eine API Anforderung ausgelöst wird:

SELECT * FROM Projects LIMIT 1

Spalten des Ergebnissatzes

Name Typ Beschreibung
TenantId String ID des Mandanten, für den das Limit gilt. Die Ausgabe enthält eine Zeile für jeden Mandanten, der während der Verbindung abgefragt wurde. Normalerweise gibt es nur eine.
AppRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 10.000). Dies gilt für alle Mandanten.
MinuteRemaining Integer Die Anzahl der API -Aufrufe der aktuellen OAuth-App in dieser Minute (max. 60). Dies gilt nur für diesen Mandanten.
DayRemaining Integer Die Anzahl der API Aufrufe, die die aktuelle OAuth-App heute hat (max. 5000). Dies gilt nur für diesen Mandanten.
RetryAfter Integer Die empfohlene Wiederholungszeit, wenn einer der oben genannten Grenzwerte beim letzten API Aufruf an den Mandanten 0 war.
LastModified Datetime Wann diese Informationen zuletzt aktualisiert wurden. Die Werte in dieser Tabelle werden nur bei API -Aufrufen aktualisiert, daher kann dieser Wert älter sein als der aktuelle Zeitpunkt.
GetOAuthAccessToken

Ruft den OAuth-Zugriffstoken ab, der für die Authentifizierung mit Xero verwendet werden soll.

Eingang
Name Typ Erforderlich Beschreibung
AuthMode String True Der zu verwendende Authentifizierungsmodustyp. Die zulässigen Werte sind APP, WEB. Der Standardwert ist WEB.
AuthToken String Falsch Das von GetOAuthAuthorizationUrl zurückgegebene Authentifizierungstoken. Nur für den Web-Authentifizierungsmodus erforderlich.
AuthKey String Falsch Der von GetOAuthAuthorizationUrl zurückgegebene AuthKey. Nur für den Web-Auth-Modus erforderlich.
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Der Wert dieses Parameters muss genau mit einem der im Developer Portal registrierten Werte übereinstimmen, einschließlich der HTTP- oder HTTPS-Schemata, der Groß- und Kleinschreibung und des abschließenden Schrägstrichs ('/').
Verifier String Falsch Das von Xero zurückgegebene Verifizierungstoken nach Verwendung der mit GetOAuthAuthorizationURL erhaltenen URL. Nur für den Web-Authentifizierungsmodus erforderlich.
PKCEVerifier String Falsch Der von GetOAuthAuthorizationURL zurückgegebene PKCEVerifier.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthAccessTokenSecret String Das von Xero zurückgegebene Authentifizierungstoken-Geheimnis. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
GetOAuthAuthorizationURL

Ruft die OAuth-Autorisierungs URL zur Authentifizierung bei verschiedenen Xero Diensten ab.

Eingang
Name Typ Erforderlich Beschreibung
CallbackURL String Falsch Dieses Feld bestimmt, wohin die Antwort gesendet wird. Dieser Wert ist nur erforderlich, wenn Sie Ihre eigene App registriert haben. Diese URL muss dieselbe Domäne haben wie die im Xero Developer Portal angegebene OAuth-Rückrufdomäne.
Scope String Falsch Die durch Leerzeichen getrennte Liste der Bereiche, die Sie von Xero anfordern. Standardmäßig werden alle Bereiche angefordert.
State String Falsch Ein Statustoken, das in die Autorisierungs URL aufgenommen werden soll. Nicht standardmäßig enthalten.
Ergebnissatzspalten
Name Typ Beschreibung
URL String Die URL zum Abschließen der Benutzerauthentifizierung.
AuthToken String Ein Token, das als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
AuthKey String Ein Schlüssel, der als Eingabe für die gespeicherte Prozedur „GetOAuthAccessToken“ verwendet wird, um die Anforderung zu überprüfen und das OAuth-Zugriffstoken abzurufen.
PKCEVerifier String Ein zufälliger Wert, der als Eingabe für GetOAuthAccessToken im PKCE-Flow verwendet wird.
Aktualisieren Sie das OAuthAccessToken

Aktualisiert das OAuth-Zugriffstoken, das für die Authentifizierung bei verschiedenen Xero Diensten verwendet wird.

Eingang
Name Typ Erforderlich Beschreibung
OAuthRefreshToken String True Das vom ursprünglichen Autorisierungscode-Austausch zurückgegebene Aktualisierungstoken.
Ergebnissatzspalten
Name Typ Beschreibung
OAuthAccessToken String Das von Xero zurückgegebene Authentifizierungstoken. Dieses kann in nachfolgenden Aufrufen anderer Vorgänge für diesen bestimmten Dienst verwendet werden.
OAuthRefreshToken String Ein Token, der zum Abrufen eines neuen Zugriffstokens verwendet werden kann.
ExpiresIn String Die verbleibende Lebensdauer des Zugriffstokens.
Mieter widerrufen

Trennt den Mandanten von dieser Anwendung. Der Benutzer muss die Autorisierung erneut durchführen, wenn er diese Anwendung das nächste Mal mit diesem Mandanten verbindet.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des zu widerrufenden Mandanten, wie in der Mandantenansicht angegeben
Ergebnissatzspalten
Name Typ Beschreibung
Success String Ob die Verbindung erfolgreich widerrufen wurde
Mieter wechseln

Ändert den Mandanten, von dem diese Verbindung Daten abruft.

Eingang
Name Typ Erforderlich Beschreibung
TenantId String Falsch Die ID des Mandanten, an den eine Verbindung hergestellt werden soll. Wenn leer, wird der aktuelle Mandant nicht geändert.
Ergebnissatzspalten
Name Typ Beschreibung
ActiveTenant String Die ID des Mandanten, der derzeit aktiv ist.

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 Xero 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, einschließlich Charge:

  • 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 Schemas 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 „Kontakte“ zurück:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Contacts'
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 „RefreshOAuthAccessToken“ zurück:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' 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 „Kontakte“ ab:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Contacts'
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:xero: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 Verschiedene 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.

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
AuthScheme Der bei der Verbindung mit Xero zu verwendende Authentifizierungstyp.
Schema Die Xero API, auf die Sie als Schema zugreifen möchten.
Tenant Legt die Xero-Organisation fest, mit der eine Verbindung hergestellt werden soll. Kann ein Name oder eine Mandanten-ID sein.

OAuth

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Scope Dadurch werden die Bereiche bestimmt, die die OAuth-Anwendung von Xero anfordert.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

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
AutoExpandDetails Setzen Sie diese Eigenschaft auf „true“, um automatisch zusätzliche Details zu Banküberweisungen, Kontaktgruppen, Spesenabrechnungen, Spesenabrechnungszahlungen, Spesenabrechnungsbelegen und Belegen einzuschließen.
IncludeArchived Legen Sie diese Eigenschaft fest, um archivierte Datensätze einzuschließen.
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.
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.
RetryDailyLimit Ob gewartet werden soll, wenn Xero meldet, dass der Anbieter sein Tageslimit erreicht hat.
RetryWaitTime Wie lange in Millisekunden gewartet werden soll, wenn eine Anforderung das Xero API Limit erreicht.
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.

Authentifizierung

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

Eigenschaft Beschreibung
AuthScheme Der bei der Verbindung mit Xero zu verwendende Authentifizierungstyp.
Schema Die Xero API, auf die Sie als Schema zugreifen möchten.
Tenant Legt die Xero-Organisation fest, mit der eine Verbindung hergestellt werden soll. Kann ein Name oder eine Mandanten-ID sein.

AuthScheme

Der bei der Verbindung mit Xero zu verwendende Authentifizierungstyp.

Mögliche Werte

Auto, OAuth, PKCE, OAuthClient

Datentyp

string

Standardwert

PKCE

Hinweise

Derzeit für neue Apps unterstützte Authentifizierungsmethoden:

  • OAuth: Authentifiziert Sie mittels OAuth mit einer Client-ID und einem geheimen Passwort. Sollte mit serverseitigen Anwendungen verwendet werden.
  • PKCE: Authentifiziert Sie mittels OAuth nur mit einer Client-ID. Sollte mit clientseitigen Anwendungen verwendet werden.
  • OAuthClient: Authentifiziert Sie mithilfe von Client-Anmeldeinformationen mit einer Client-ID und einem Geheimnis. Kann nur verwendet werden, wenn Sie eine Custom Connection-Lizenz von Xero erworben haben.
  • Auto: Verwendet den Wert der XeroAppAuthentication-Eigenschaft, um den Authentifizierungsmodus zu bestimmen. XeroAppAuthentication ist nur aus Gründen der Abwärtskompatibilität enthalten und alle neuen Verbindungen sollten eine andere AuthScheme-Eigenschaft verwenden.

Schema

Die Xero API, auf die Sie als Schema zugreifen möchten.

Mögliche Werte

ACCOUNTING, ASSETS, PAYROLLAUS, FILES, PROJECTS

Datentyp

string

Standardwert

ACCOUNTING

Hinweise

Der Connector unterstützt die Accounting API, die Assets API, die Australian Payroll API, die Files API und die Projects API. Setzen Sie die SchemaVerbindungseigenschaft zu Accounting, Assets, PayrollAUS, Files oder Projects, um eine Verbindung zu einer der entsprechenden APIs herzustellen.

Mieter

Legt die Xero-Organisation fest, mit der eine Verbindung hergestellt werden soll. Kann ein Name oder eine Mandanten-ID sein.

Datentyp

string

Standardwert

""

Hinweise

Xero-Apps können gleichzeitig für mehrere Organisationen autorisiert werden. Standardmäßig stellt der Connector eine Verbindung zum ersten verfügbaren Mandanten her. Um zu steuern, mit welcher Organisation Sie verbunden sind, aktivieren Sie diese Option.

Diese Option kann entweder auf den Namen Ihrer Organisation oder auf die Mandanten-ID eingestellt werden. Wenn Sie mehrere Organisationen mit demselben Namen haben, müssen Sie die Mandanten-ID verwenden. Sie können die Mandanten-ID finden, indem Sie eine Verbindung herstellen, diese Option nicht festlegen und dann die Mandantenansicht abfragen.

OAuth

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

Eigenschaft Beschreibung
InitiateOAuth Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.
OAuthClientId Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
OAuthClientSecret Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.
Scope Dadurch werden die Bereiche bestimmt, die die OAuth-Anwendung von Xero anfordert.
OAuthSettingsLocation Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH gesetzt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.
CallbackURL Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.
OAuthVerifier Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.
OAuthRefreshToken Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.
OAuthExpiresIn Die Lebensdauer des OAuth AccessToken in Sekunden.
OAuthTokenTimestamp Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

OAuth initiieren

Legen Sie diese Eigenschaft fest, um den Prozess zum Abrufen oder Aktualisieren des OAuth-Zugriffstokens beim Herstellen einer Verbindung zu starten.

Mögliche Werte

OFF, GETANDREFRESH, REFRESH

Datentyp

string

Standardwert

OFF

Hinweise

Folgende Optionen stehen zur Verfügung:

  1. OFF: Gibt an, dass der OAuth-Flow vollständig vom Benutzer gehandhabt wird. Zur Authentifizierung ist ein OAuthAccessToken erforderlich.
  2. GETANDREFRESH: Gibt an, dass der gesamte OAuth-Flow vom Connector verarbeitet wird. Wenn derzeit kein Token vorhanden ist, wird es durch eine entsprechende Aufforderung an den Benutzer über den Browser abgerufen. Wenn ein Token vorhanden ist, wird es bei Bedarf aktualisiert.
  3. REFRESH: Gibt an, dass der Connector nur das Aktualisieren des OAuthAccessToken übernimmt. Der Benutzer wird vom Connector nie aufgefordert, sich über den Browser zu authentifizieren. Der Benutzer muss zunächst das Abrufen des OAuthAccessToken und des OAuthRefreshToken übernehmen.

OAuthClientId

Die Client-ID, die zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId-Wert, manchmal auch Consumer-Schlüssel genannt, und ein Client-Geheimnis, das OAuthClientSecret.

OAuthClientSecret

Das Client-Geheimnis, das zugewiesen wird, wenn Sie Ihre Anwendung bei einem OAuth-Autorisierungsserver registrieren.

Datentyp

string

Standardwert

""

Hinweise

Im Rahmen der Registrierung einer OAuth-Anwendung erhalten Sie die OAuthClientId, auch Consumer-Schlüssel genannt. Sie erhalten außerdem ein Client-Geheimnis, auch Consumer-Geheimnis genannt. Legen Sie das Client-Geheimnis im OAuthClientSecret Eigentum.

Umfang

Dadurch werden die Bereiche bestimmt, die die OAuth-Anwendung von Xero anfordert.

Datentyp

string

Standardwert

""

Hinweise

Standardmäßig fordert der Connector den Benutzer auf, alle verfügbaren Bereiche zu autorisieren. Wenn Sie dies überschreiben möchten, können Sie diese Eigenschaft auf eine durch Leerzeichen getrennte Liste von OAuth-Bereichen setzen.

OAuthSettingsLocation

Der Speicherort der Einstellungsdatei, in der OAuth-Werte gespeichert werden, wenn InitiateOAuth auf GETANDREFRESH oder REFRESH eingestellt ist. Alternativ können Sie diesen Speicherort im Speicher halten, indem Sie einen Wert angeben, der mit beginnt 'memory://'.

Datentyp

string

Standardwert

%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt

Hinweise

Wenn InitiateOAuth ist auf gesetzt GETANDREFRESH oder REFRESH, der Treiber speichert OAuth-Werte, damit der Benutzer die OAuth-Verbindungseigenschaften nicht manuell eingeben muss und die Anmeldeinformationen über Verbindungen oder Prozesse hinweg gemeinsam genutzt werden können.

Anstatt einen Dateipfad anzugeben, können Sie auch den Speicherort angeben. Speicherorte werden durch einen Wert angegeben, der mit 'memory://' gefolgt von einer eindeutigen Kennung für diesen Satz von Anmeldeinformationen (z. B. memory://user1). Die Kennung können Sie frei wählen, sie sollte jedoch für den Benutzer eindeutig sein. Im Gegensatz zur dateibasierten Speicherung, bei der die Anmeldeinformationen über Verbindungen hinweg bestehen bleiben, werden die Anmeldeinformationen bei der Speicherspeicherung in den statischen Speicher geladen und die Anmeldeinformationen werden für die Dauer des Prozesses unter Verwendung derselben Kennung zwischen Verbindungen geteilt. Um die Anmeldeinformationen außerhalb des aktuellen Prozesses beizubehalten, müssen Sie die Anmeldeinformationen vor dem Schließen der Verbindung manuell speichern. Auf diese Weise können Sie sie in der Verbindung festlegen, wenn der Prozess erneut gestartet wird. Sie können OAuth-Eigenschaftswerte mit einer Abfrage an abrufen sys_connection_propsSystemtabelle. Wenn mehrere Verbindungen mit denselben Anmeldeinformationen bestehen, werden die Eigenschaften aus der zuvor geschlossenen Verbindung gelesen.

Der Standardspeicherort ist „%APPDATA%\CData\ Acumatica Data Provider\OAuthSettings.txt“ mit %APPDATA% auf das Konfigurationsverzeichnis des Benutzers gesetzt. Die Standardwerte sind

  • Windows: "register://%DSN"
  • Unix: "%AppData%..."

wobei DSN der Name des aktuellen DSN ist, der in der offenen Verbindung verwendet wird.

Die folgende Tabelle listet den Wert von auf %APPDATA% nach Operationssystem:

Plattform %APPDATA%
Windows Der Wert der Umfeld APPDATA
Linux ~/.config

Rückruf-URL

Die OAuth-Rückruf URL, zu der bei der Authentifizierung zurückgekehrt werden soll. Dieser Wert muss mit der Rückruf-URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

Datentyp

string

Standardwert

http://localhost:33333

Hinweise

Während des Authentifizierungsprozesses leitet der OAuth-Autorisierungsserver den Benutzer an diese URL weiter. Dieser Wert muss mit der Rückruf URL übereinstimmen, die Sie in Ihren App-Einstellungen angeben.

OAuthVerifier

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode.

Datentyp

string

Standardwert

""

Hinweise

Der von der OAuth-Autorisierungs URL zurückgegebene Prüfcode. Dieser kann auf Systemen verwendet werden, auf denen kein Browser gestartet werden kann, z. B. auf Headless-Systemen.

Authentifizierung auf Headless-Maschinen

Siehe, um die zu erhalten OAuthVerifier Wert.

OAuthSettingsLocation festlegen zusammen mit OAuthVerifier. Beim Verbinden tauscht der Connector die OAuthVerifier für die OAuth-Authentifizierungstoken und speichert sie verschlüsselt am angegebenen Speicherort. Setzen Sie InitiateOAuth zu GETANDREFRESH, um den Austausch zu automatisieren.

Sobald die OAuth-Einstellungsdatei generiert wurde, können Sie entfernen OAuthVerifier aus den Verbindungseigenschaften und verbinden Sie sich mit OAuthSettingsLocation festgelegt.

Um die OAuth-Tokenwerte automatisch zu aktualisieren, legen Sie OAuthSettingsLocation fest und setzen Sie zusätzlich InitiateOAuth zum AKTUALISIEREN.

OAuthRefreshToken

Das OAuth-Aktualisierungstoken für das entsprechende OAuth-Zugriffstoken.

Datentyp

string

Standardwert

""

Hinweise

Der OAuthRefreshToken Eigenschaft wird verwendet, um den OAuthAccessToken zu aktualisieren bei Verwendung der OAuth-Authentifizierung.

OAuthLäuftAbIn

Die Lebensdauer des OAuth AccessToken in Sekunden.

Datentyp

string

Standardwert

""

Hinweise

Mit OAuthTokenTimestamp kombinieren, um zu bestimmen, wann der AccessToken abläuft.

OAuthTokenTimestamp

Der Unix-Epochenzeitstempel in Millisekunden, als das aktuelle Zugriffstoken erstellt wurde.

Datentyp

string

Standardwert

""

Hinweise

Kombinieren Sie es mit OAuthExpiresIn, um zu bestimmen, wann das AccessToken abläuft.

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 über 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%\Xero 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 Eigenschaft wird nur benötigt, wenn Sie Definitionen anpassen möchten (z. B. einen Spaltennamen ändern, eine Spalte ignorieren usw.) oder das Datenmodell mit neuen Tabellen, Ansichten oder gespeicherten Prozeduren erweitern möchten.

Notiz

Da dieser Connector mehrere Schemas unterstützt, ist die Struktur für benutzerdefinierte Xero Schema wie folgt:

  • Jedem Schema wird ein Ordner zugewiesen, der diesem Schema entspricht.
  • Diese Schema sind in einem übergeordneten Ordner enthalten.
  • Der parent folder sollte als gesetzt werden Location, kein Ordner eines einzelnen Schemas.

Wenn nichts angegeben wird, ist der Standardspeicherort „%APPDATA%\ Xero 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
AutoExpandDetails Setzen Sie diese Eigenschaft auf „true“, um automatisch zusätzliche Details zu Banküberweisungen, Kontaktgruppen, Spesenabrechnungen, Spesenabrechnungszahlungen, Spesenabrechnungsbelegen und Belegen einzuschließen.
IncludeArchived Legen Sie diese Eigenschaft fest, um archivierte Datensätze einzuschließen.
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.
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.
RetryDailyLimit Ob gewartet werden soll, wenn Xero meldet, dass der Anbieter sein Tageslimit erreicht hat.
RetryWaitTime Wie lange in Millisekunden gewartet werden soll, wenn eine Anforderung das Xero API Limit erreicht.
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.

AutoExpandDetails

Setzen Sie diese Eigenschaft auf „true“, um automatisch zusätzliche Details zu Banküberweisungen, Kontaktgruppen, Spesenabrechnungen, Spesenabrechnungszahlungen, Spesenabrechnungsbelegen und Quittungen einzuschließen.

Datentyp

bool

Standardwert

false

Hinweise

Mögliche Werte sind True und False. Wenn dieser Wert auf True gesetzt ist, enthalten einige Spalten Daten, die sonst NULL wären, aber das Lesen dieser Tabellen wird dadurch langsamer als standardmäßig.

Wenn dieser Wert auf False gesetzt ist (Standard), besteht die einzige Möglichkeit, zusätzliche Details aus diesen Tabellen abzurufen, darin, einzelne Elemente explizit auszuwählen:

SELECT * FROM ExpenseClaims WHERE ExpenseClaimId = '...'

EinschließenArchiviert

Legen Sie diese Eigenschaft fest, um archivierte Datensätze einzuschließen.

Datentyp

bool

Standardwert

false

Hinweise

Mögliche Werte sind True und False.

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.

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. „*=*“.

Tägliches Wiederholungslimit

Ob gewartet werden soll, bis Xero meldet, dass der Anbieter sein Tageslimit erreicht hat.

Datentyp

bool

Standardwert

false

Hinweise

Von der Verwendung dieser Option wird dringend abgeraten. Siehe Xero API Limits für weitere Einzelheiten.

Standardmäßig schlägt der Connector fehl, wenn er das tägliche API Limit erreicht, um übermäßige Wartezeiten zu vermeiden. Wenn diese Option aktiviert ist und der Connector das tägliche API Limit erreicht, wird er stattdessen verzögert und nach der von Xero empfohlenen Zeitspanne erneut versucht. Dies kann möglicherweise zu einer Verzögerung des Connectors von mehreren Stunden führen.

Wartezeit für erneuten Versuch

Wie lange in Millisekunden gewartet werden soll, wenn eine Anforderung das Xero API Limit erreicht.

Datentyp

string

Standardwert

10000

Hinweise

Wenn der Connector mehr Anfragen ausgibt, als Xero zulässt, bestimmt diese Option, wie lange der Connector wartet, bevor er eine weitere Anfrage ausgibt. Es wird empfohlen, diesen Wert zu erhöhen, wenn mehrere Treiber aktiv sind, z. B. bei Verwendung von Power BI.

Dieser Wert wird in Millisekunden angegeben. Um eine Verzögerung von 10 Sekunden zu verwenden, muss diese Eigenschaft auf 10.000 gesetzt werden.

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 Contacts 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.