API-Referenz · v1
Die Sway-API
Eine REST-API für KI-Agenten und Entwickler von Drittanbietern, um Sway-Daten abzufragen und zu bearbeiten: Arbeitsbereiche, Bankkonten, Rechnungen, Zahlungen und das Hauptbuch.
- Basis-URL
https://api.business.swayapp.io/v1- Auth
Authorization: Bearer <token>- Format
- JSON · OpenAPI 3.1.0 · 19 Ressourcen
Leitfäden
Wie Sie einen Schlüssel senden, eine ganze Liste lesen und einen Fehler behandeln, mit Code zum Kopieren.
AuthentifizierungSenden Sie einen API-Schlüssel als Bearer-Token, begrenzen Sie ihn mit Bereichen auf die Ressourcen, die Ihre Software braucht, und ersetzen Sie ihn, bevor er abläuft.PaginierungLesen Sie eine ganze Liste Seite für Seite mit ihrem Cursor, holen Sie Elemente über ihre IDs, behalten Sie nur die nötigen Felder, und blättern Sie durch Suchergebnisse.FehlerLesen Sie den Status und den stabilen Code eines Fehlers, finden Sie seine Ursache in seinen Details, bleiben Sie unter dem Anfragelimit, und wiederholen Sie nur, was sich gefahrlos wiederholen lässt.Claude-ConnectorVerbinden Sie Claude Desktop mit einem API-Schlüssel mit Ihren Sway-Arbeitsbereichen, fragen Sie Claude dann nach Ihren Rechnungen, Banktransaktionen und Ihrem Hauptbuch, und lassen Sie Claude handeln, wenn Sie es erlauben.
Fragen Sie Claude nach Ihren Sway-DatenDer Sway-Connector für Claude Desktop liest Ihre Arbeitsbereiche über die API, mit einem Schlüssel, den Sie auf das begrenzen, was Claude sehen darf. Claude-Connector einrichten
Ressourcen
Jede Ressource hat ihre eigene Seite: ihre Endpunkte, ihr Objekt und ein Beispiel jeder Anfrage und jeder Antwort.
Workspace
- WorkspacesA workspace holds the bank accounts, invoices, payments and accounting of one company.3 Endpunkte
- MembershipsA membership gives a user a role in a workspace.3 Endpunkte
- InvitationsAn invitation asks a person, by email, to join a workspace with a given role.6 Endpunkte
- ConsentsA consent lets Sway read the data of bank accounts or initiate payments from them.7 Endpunkte
Banking
- Bank accountsA bank account, connected through a consent or managed offline, holds its transactions and past balances.15 Endpunkte
- Currency exchangesA currency exchange holds the exchange rates from one base currency to other currencies.1 Endpunkt
Billing
- InvoicesAn invoice is a sales invoice or a supplier bill of the workspace.12 Endpunkte
- CounterpartiesA counterparty is a customer or a supplier the workspace trades with.6 Endpunkte
- ProductsA product is a good or a service with the sale and purchase details used on invoices.5 Endpunkte
Payments
- PaymentsSummarize a payment before you create or initiate it.1 Endpunkt
- Draft paymentsA draft payment is a payment prepared in Sway and not yet sent to the bank.4 Endpunkte
- Initiated paymentsAn initiated payment is a payment sent to the bank for execution.3 Endpunkte
Accounting
- Ledger entriesA ledger entry books an amount to an account of the chart of accounts.6 Endpunkte
- Chart of accountsA chart of accounts lists the accounts and the account groups of the workspace accounting.11 Endpunkte
- Tax typesA tax type sets a tax rate and the accounts that book the tax.4 Endpunkte
- Account coding rulesAn account coding rule codes the bank transactions that match its conditions.11 Endpunkte
Files and account
Release Notes mit API-Bezug
Alle API-ÄnderungenAPI-Changelog
- Core Services 1.225.0NeuA documented openapi.json now describes the Sway API with each release
- Core Services 1.225.0NeuThe API reference now documents the shared types
- Core Services 1.225.0NeuThe API reference now points to the api.business.swayapp.io domain
- Core Services 1.222.0FixImproved handling of pagination edge cases
- Core Services 1.221.0NeuUpload bank statements to a bank account and parse their transactions directly through the API
- Core Services 1.220.0NeuUpload invoices, bills and bank statements straight through the API
- Core Services 1.216.0FixInvoice search returns receivable invoices too, and finds an invoice by its counterparty name
- Web App 1.45.0NeuA new developer page lets you create, view and revoke your API keys, with scopes and expiry of your choice
- Core Services 1.215.0NeuYou can now create API keys with their own expiry date and permission scopes
- Core Services 1.211.0NeuAdd support to download exported files
- Core Services 1.207.0NeuSway now offers a REST API with API key support, making it possible to integrate Sway with external tools and services
Jeder Eintrag führt zum Release, das ihn geliefert hat, mit allen übrigen Änderungen dieses Releases.
Bauen Sie auf Ihren eigenen Daten.
Erstellen Sie ein Konto, öffnen Sie Profil › Entwickler und erstellen Sie einen Schlüssel, der auf die nötigen Ressourcen begrenzt ist. Fragen zu einer Integration? Das Team beantwortet sie in einem Gespräch.