Steuersatz-API
Anleitung zur technischen Integration in die Steuersatz-API von LOVAT
Einführung
Die folgende Dokumentation enthält Informationen zu Elementen der OMP-API, einschließlich Anforderungen, Antworten und Fehlercodes.
So integrieren Sie die OMP-Steuersatz-API:
- Registieren Sie ein Lovat OMP-Konto.
-
Füllen Sie ein Firmenprofil.
-
Wählen Sie einen Plan.
-
Richten Sie Webhooks ein.
-
Holen Sie sich einen Token.
- Festlegen Sie Steuerregeln.
Begriffe und Abkürzungen
API – Programmierschnittstelle. Eine Reihe von Aufrufen, die vom System bereitgestellt werden, erfordern die Integration in externe Softwareprodukte.
Merchant – der Besitzer eines Online-Shops.
Customer – eine Person, die für Waren oder Dienstleistungen bezahlt.
Transaction – Überweisung von Geldern für Waren oder Dienstleistungen, die der Kunde vom Händler erhalten hat.
Token – eine geheime Zeichenfolge, die vom System verwendet wird, um den Händler und die Website zu identifizieren, über die die Transaktion registriert wird.
API-Referenz
Die Lovat-API verwendet die REST-Architektur. Die API verfügt über vorhersehbare, ressourcenorientierte URLs und verwendet HTTP-Antwortcodes, um API-Fehler anzuzeigen. Die API antwortet immer im JSON-Format, einschließlich Fehlerfällen.
Authentifizierung
Die Authentifizierung bei der Tax Rate API erfolgt über die Basisauthentifizierung des HTTP-Headers. Abonnenten müssen ein Token als Basisauthentifizierungswert angeben. Wenn Sie Lovat noch nicht kennen, müssen Sie sich für ein Konto anmelden, um Ihren API-Schlüssel zu erhalten. Die API verwendet integrierte HTTP-Funktionen wie die HTTP-Authentifizierung und HTTP-Verben, die von handelsüblichen HTTP-Clients interpretiert werden können. Es unterstützt auch die gemeinsame Nutzung von Ressourcen zwischen verschiedenen Ursprüngen, sodass Sie von einer Client-Webanwendung sicher darauf zugreifen können.
URL
Die Lovat-API verwendet die folgenden Endpunktpfade:
-
Produktionsregion:
https://merchant.vatcompliance.co/api/1/tax_rate — Tax Rate API
-
Testregion:
sandbox.vatcompliance.co/api/1/tax_rate
Der Anforderungstyp: POST
https://merchant.vatcompliance.co/api/1/tax_rate/{access_token}
JSON Params
Parameter | Type | Description | Required |
transaction_id | String |
Maximal 255 Zeichen. |
optional |
сurrency
|
String
|
Transaktionswährung. Drei-Buchstaben-Währungscode gemäß ISO 4217. |
optional |
If_digital | Bol |
Erforderlich für digitale Dienste |
optional |
transaction_sum | Float |
Gesamtbetrag der Bestellung |
optional |
delivery_fee | Float |
Gesamtversandmenge für die Bestellung |
optional |
arrival_country
|
String
|
Ein Land, in das die Bestellung versandt wurde. Drei-Buchstaben-Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-3 |
erforderlich |
arrival_zip | String |
Erforderlich für US-Bestellungen: Postleitzahl, an die die Bestellung versendet wurde |
erforderlich für die US-Bestellungen
|
arrival_state | String |
Für USA, Kanada, Großbritannien: Zwei-Buchstaben-ISO-Statuscode, an den die Bestellung versandt wurde |
optional |
departure_country | String |
Dreistelliger ISO-Ländercode des Landes, aus dem die Bestellung versandt wurde. Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben |
optional
|
departure_zip | String |
Für US-Bestellungen: Postleitzahl, von der aus die Bestellung versandt wurde |
optional |
departure_state | String |
Für USA, Kanada: Zwei-Buchstaben-ISO-Statuscode, von dem aus die Bestellung versandt wurde |
optional |
service_code | String |
Erforderlich für digital bereitgestellte Dienste. Steuerkategorien digitaler Dienste |
optional |
good_code | String |
Code eines Gutes gemäß dem achtstelligen Kodierungssystem der EU Die kombinierte Nomenklatur (CN) |
optional |
vat_number_of_buyer | String |
Steuernummer des Käufers |
optional |
buyer_ip | String |
IP-Adresse des Käufers. Erforderlich für digitale Dienste |
erforderlich für digitale Dienste |
exemption_type | String |
Nur für US-Bestellungen |
optional |
phone_number_of_buyer | String |
Optional für digitale Dienste. Mindestens 5 erste Ziffern bestehen aus der Landesvorwahl |
Optional |
bank_country_of_buyer | String |
Optional für digitale Dienste. Drei-Buchstaben-Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-3 |
optional |
Fehlerliste
Liste der unterstützten HTTP-Fehler:
200, 201, 204
No error
400 Bad Request
This often indicates a required parameter missing. Refer to the response body for details
401 Unauthorized
No valid API key provided
402 Request Failed
Request failed despite valid parameters
403 Forbidden
No permission. Refer to the response body for details
404 Not Found
The requested item doesn’t exist
409, 422
Invalid request parameters
412 Precondition Failed
The project has not been activated yet (used in the Get Token method)
415 Unsupported Media Type
‘Content-Type: application/json’ missing in HTTP header
500, 502, 503, 504 Server Errors
Something went wrong
Beispiel für eine Abfrageanforderung
Beispielanforderung von der Konsole:
curl-v GET https://merchant.vatcompliance.net/api/1/VAT_rate/get/5aae918d97964ff88df64b059c2cc0f8 --header "Content-Type: application/json" \ -d '{ "arrival_country": "ITA", "departure_country": "GBR", "transaction_id": "7668999765", "transaction_sum": 10, "vat_number_of_buyer": "IT8996543" }' { "arrival_country": "GBP", "currency": "EUR", "delivery_fee": 0, "departure_country": "HUN", "vat_number_of_buyer": "IT8996543", "transaction_datetime": "2021-01-09", "transaction_id": "45000098" } { "arrival_country": "USA", "arrival_state": "NY", "arrival_zip": "10034", "departure_country": "USA", "departure_state": "TX", "departure_zip": "77554", "transaction_datetime": "2021-01-01", "transaction_id": "788654333" }
Antwortelemente
Parameter |
Typ / Beispiel |
Beschreibung |
transaction_type | “export/import”, “b2c_distance_sales”, “reverse_charge” | |
transaction_jurisdiction | “ITA”, “GBR” |
Dreistelliger ISO-Ländercode des Landes, in dem die Bestellung steuerpflichtig ist. Alle Länder sind als Zeichenfolgen gemäß ISO 3166-1 Alpha-3 angegeben |
taxable_state | “NY” |
Für USA, Kanada, Großbritannien: ISO-Code ist mit zwei Buchstaben, bei dem die Bestellung steuerpflichtig |
sales_tax_rate | 8 |
Umsatzsteuersatz |
vat_rate | 20 |
Mehrwertsteuersatz |
export_country | “USA”, “GBR” |
Exportland für Bestellungen mit Transaktionsart Export / Import |
import_country | “USA”, “GBR” |
Importland für Bestellungen mit Transaktionsart Export / Import |
Beispielantwort
{ "transaction_type": "b2c_distance_sales", "taxable_jurisdiction": "USA", "taxable_state": "NY", "sales_tax_rate": 8.25 } { "transaction_type": "export/import", "taxable_jurisdiction": "GBR", "vat_rate": 0, "export_country": "GBR", "import_country": "ITA" } { "transaction_type": "reverse_charge", "taxable_jurisdiction": "FRA", "vat_rate": 0 }
Datumsformat
Alle Daten werden gemäß ISO 8601 als Zeichenfolgen angegeben. Sie können Datumszeichenfolgen entweder in UTC (z. B. 2013-01-15T00: 00: 00Z) oder unter Angabe des UTC-Offsets (z. B. 2013-01-15T00: 00: 00) angeben -08: 00 für acht Stunden hinter UTC). Berücksichtigen Sie im letzteren Fall gegebenenfalls die Sommerzeit.
Länder
Wir unterstützen die folgenden Länder auf der ganzen Welt: USA, EU-Länder, Großbritannien, Russland, Ukraine, Weißrussland, Norwegen, Kanada, Australien, Japan.
Steuerkategorien digitaler Dienste
Audio / visueller Inhalt |
1 |
Live-Streaming |
2 |
Telefondienste |
3 |
Internet-Telefondienste |
4 |
Anrufverwaltungsdienste |
5 |
Paging-Dienste |
6 |
Internet Zugang |
7 |
Bilder |
8 |
Musik |
9 |
Spiele |
10 |
E-Zeitungen |
11 |
Web-Hosting |
12 |
Distanzpflege von Programmen |
13 |
Werbefläche auf einer Website |
14 |
E-Books |
15 |
Lizenzen |
16 |
Dating | 17 |
Fernstudium |
18 |
Glücksspiel |
19 |
Anrufbegrenzung
Wir beschränken API-Anfragen für Händlerpläne auf 1.000 pro Minute. Möglicherweise haben Sie mehr Anrufe als Ihr monatliches Planlimit. Durchschnittliche Gebühren werden separat berechnet, wenn Sie Ihr Planlimit im nächsten Monat überschreiten.
Ausnahmetypen
Für US-Bestellungen nur Arten von Ausnahmen: Großhandel, Regierung, Marktplatz, andere, nicht befreit oder Null.