RetailForce Fiscal Service – api-beskrivning

Bokför ingående kassa för en kassaavslutningsrapport. Bokför endast en inbetalning, justerar inte kassabehållningen.

Alternativ: Som alternativ kan kassan även bokföra ett dokument: documentType [11] = PayIn.

Bokför en kassaskillnad i redovisningssystemet.

Alternativ: Som alternativ kan kassan också bokföra ett dokument med BusinessTransactionType [91] = CashDifference.

Bokför en penningöverföring från kassasystemet till banken (eller någon annan mottagare).

Returnerar det faktiska saldot för betalningar för en specifik client. Detta beräknas utifrån de överförda dokumenten (förutom försäljnings- och returkvitton, insättningar och uttag etc.).

Kontrollerar det faktiska saldot för betalningarna för denna kassa och returnerar en lista över betalningar med avvikelse (eller en tom lista om det inte finns någon avvikelse).

Avslutar den aktuella dagen med en avslutningsrapport.

Avslutningen görs utifrån de dokument som skickats till klienten sedan senaste avslutningen. Kassasystemet får inte tillbaka någon avslutningsrapport!

Returnerar dagsslutsdokumentet för den aktuella dagen.

Det returnerade dokumentet måste sparas (storeDocument > documentType 99)

Returnerar datum och tid för den senaste avslutningen för en specifik client (terminal)

Returnerar information om huruvida en daglig avstängning ska göras vid en viss terminal eller inte. (Beroende på RetailForce.Fiscalisation.Implementation.
IFiscalCountryProperties.
MaximumHourIntervalForClosing).

Skapar en ny client i konfigurationslagret. Konfigurationsobjektet måste förberedas av POS-systemet.

Konfiguration av en client krävs för drift. Använd antingen denna slutpunkt eller:

• PUT /api/v1/management/clients, eller
• 
  PUT /api/v1/management/clients/byCloud/ID.

Uppdaterar en clientkonfiguration som skapats av kassasystemet i konfigurationslagret.

Returnerar alla klienter som finns listade i konfigurationslagret.

Kan även användas vid Cloud-konfiguration.

Skapar en ny client med en konfiguration som förberetts i Cloud / eller laddar en befintlig client.

En clients konfiguration krävs för driften. Använd antingen:

• denna slutpunkt, eller
• PUT /api/v1/management/clients, eller
• PUT /api/v1/management/clients/
  byCloud/ID.

Skapar en client genom att ladda konfigurationsdata från Cloud.

Alternativ: alternativ slutpunkt till PUT /api/v1/management/clients och PUT /api/v1/management/clients/byCloud.

Uppdaterar klientkonfigurationen genom att hämta den från Cloud.

Används när den konfiguration som förberetts i Cloud har uppdaterats och ska hämtas på nytt av skatteklienten (uppdatering).

Skapar en ny client i skattemodulens hantering och lägger till denna client i Cloud-konfigurationen.

Clienten skapas i det lokala konfigurationslagret och konfigurationsobjektet laddas sedan upp till Cloud-systemet.

Obs: Distributören måste vara angiven i clientuppgifterna och distributören måste ha behörighet att skapa nya klienter.

Upprättar en Cloud-anslutning för den specifika klienten och laddar den betrodda skattemodulen till cachen.

Krävs för system som använder Cloud-funktioner.

Måste utföras efter varje omstart av kassasystemet.

Uppdaterar den aktuella licensnyckeln i skatteklientens konfiguration (även på hårddisken). Krävs om licenserna i Cloud-konfigurationen har ändrats.

Metod för att starta eller stoppa bearbetningen av molnköer (för alla klienter).

Kommandot Stop avbryter bearbetningen efter att den aktuella uppladdningen har slutförts.

Start startar köbehandlingen omedelbart.

Om Cloud-köbehandlingen stoppas måste du starta om den, såvida inte tjänsten startas om (då aktiveras Cloud-behandlingen igen).

Returnerar klientkonfigurationen för en specifik klient.

Tar bort en specifik client

Observera: använd med försiktighet!

Returnerar det unika client-ID:t för de begärda parametrarna.

Olika parametrar kan användas för att begära uniqueClientId.

Returnerar licenskonsument-ID:t för den angivna företagsidentifikationen.

Endast LicenseConsumerId:er som redan är lagrade i konfigurationslagret returneras.

Validerar den angivna clientinformationen för att uppfylla nödvändiga landsspecifika konfigurationskrav.

Används för att validera en konfiguration som skapats av kassasystemet innan /api/v1/management/clients används.

Validering av molnkonfigurationen sker i Cloud-systemet.

Initialiserar redovisningsenheten (samt eventuell hårdvara och eventuell anmälan till skattemyndigheterna).

Initialiseringen sker via startkvittot (det första kvittot), som antingen kan hämtas via slutpunkten GET /api/v1/transactions/document/
{clientId}/start, eller så skapas startdokumentet av kassasystemet.

Migrerar en client från en annan leverantör av skattehanteringslösningar.

Används vid byte från en annan leverantör av skattehanteringsmiddleware till RetailForce

Observera vilka system som stöds.

Migrerar en client från en annan leverantör av skattehanteringstjänster och utför en filimport.

Observera vilka system som stöds!

Avregistrering av skattepliktig client (samt eventuell hårdvara och eventuell anmälan till skattemyndigheterna).

Laddar upp ett Support Package (loggfiler) till Clouden för den angivna clienten.

Denna ändpunkt krävs för att kunna använda funktionen ”Ladda upp Support Package” i Cloud-systemet.

Säkerhetskopierar en client till det angivna filnamnet (säkerhetskopia som zip-fil).

Om Cloud-uppladdning används kommer bearbetningen av molnkön att stoppas och startas om (och molnkön kommer att initialiseras på nytt).

Observera: Tänk på att om clienten inte tas bort kommer Cloud-köprocessen att återupptas efter säkerhetskopieringen. Om några filer inte fanns före säkerhetskopieringen ingår de också i säkerhetskopian och kan eventuellt laddas upp två gånger om clienten återställs.

Återställer en client (med all data) från den angivna ZIP-filen med säkerhetskopian.

Skapar en ny client med konfiguration från Cloud / eller laddar en befintlig client.

Skapar en ny client med konfiguration från Cloud / eller laddar en befintlig client.

Genererar ett nytt eller returnerar ett befintligt, globalt unikt ID för respektive client. Dessutom aktiveras utfärdandet av retailForceReceiptId för respektive client.

Lagrar ett externt certifikat i skattemodulens certifikatarkiv.

Krävs för system som INTE använder RetailForce Cloud-funktioner i länder där programvarucertifikat används i samband med skattehantering (Slovenien, Kroatien, Spanien,…)

Returnerar information om huruvida den begärda clienten har den begärda åtkomstlicensen.

Returnerar om den begärda klienten har den begärda licensen.

Skapar en AES-användarnyckel för denna klient och returnerar den. AES-nyckeln sparas även i klientkonfigurationen.

Obs: AES-användarnyckeln skapas automatiskt av den skattemässiga clienten. Endpunkten behövs endast om AES-nyckeln ska skapas manuellt.

Returnerar AES-nyckeln för den angivna clienten.

Exporterar alla kvittorader från den lokala datainsamlingsloggen (DEP §7 RKSV).

Krävs för offlinesystem (system som INTE använder Cloud-arkivering av skattedata).

Exporterar alla data som begärs för DEP131-protokollet (DEP §131 BAO) från lokalt lagrade data.

Returnerar startkvittot för denna client.

Kassasystemet måste kunna tillhandahålla startkvittot på begäran vid en skatterevision. Om POS-systemet inte har lagrat startkvittot kan det begäras via denna ändpunkt.

Returnerar alla månadskvitton inom den begärda tidsramen.

Kassasystemet måste kunna tillhandahålla månadskvitton på begäran under en skatterevision. Om POS-systemet inte har lagrat dessa dokument kan de begäras via denna ändpunkt.

Returnerar alla signaturenheter och anger om de är aktiverade på FinanzOnline (Fon) eller inte.

Registrerar den konfigurerade signaturenheten på Fon (om en sådan är konfigurerad) eller den signaturenhet som identifieras med certificateSerial.

Obs: Om RetailForce Cloud Services används registreras certifikaten automatiskt i FinanzOnline-portalen (Fon) (à inloggningsuppgifter för användaren av kassasystemets webbtjänst krävs!); slutpunkten behövs endast om registreringen ska göras manuellt.

Avregistrerar den konfigurerade signaturenheten hos Fon (om en sådan är konfigurerad) eller den signaturenhet som identifieras med certificateSerial.

Observera: använd med försiktighet!

Validerar det senast signerade dokumentet i DEP hos FinanzOnline (Fon).

Validerar det angivna DEP-dokumentet (QR-kod) hos Fon.

Returnerar information om huruvida den aktuella clients kassaapparat är aktiverad hos Fon.

Krävs för offlinesystem.

Registrering av kassasystemet hos Fon för den aktuella klienten.

Krävs för offlinesystem.

Avregistrera kassasystemet hos Fon för den aktuella kunden.

Krävs för offline-system.

Observera: använd med försiktighet!

Skickar stängningskommandot (Z) till kvittoskrivaren.

Skickar kommandot för tidssynkronisering (L) till den skattepliktiga skrivaren.

Denna funktion kan användas för att generera en så kallad KLEN-rapport.

(från v1.8.3)

Denna funktion används för att skriva ut

• detaljerade och
• sammanfattade periodrapporter.

(från v1.8.3)

Denna funktion används för att skriva ut en så kallad BLOCK-rapport.

(från v1.8.3)

Exporterar SAF-T-formatet för Danmark till den angivna streamen.

Returnerar alla begärda revisionsloggposter sorterade efter datum.

Returnerar de lokalt lagrade arkiven för stängning.

Metod för att verifiera det franska arkivet.

Returnerar en array med anslutna lokala TSE-enheter och deras status.

Kör ett synkront självtest för den angivna kassan på TSE-enheten (kassan är valfri).

Gör en testanslutning till den angivna TSE:n.

Returnerar alla klienter som är listade på den angivna klientens TSE.

Returnerar statusen för TSE. Om ingen skattemodul hittas returneras statusen RetailForce.Fiscalisation.Implementation.
Germany.Tse.TseStatus.Critical.

Uppdaterar tiden på TSE till den aktuella datortiden.

Exporterar tar-filerna från den primära TSE:n.

Krävs för offlinesystem.

Exporterar taxonomin (DSFinV-K export) och returnerar den som en nedladdningsfil (zip-format).

Krävs för offlinesystem.

Returnerar alla aktiva (påbörjade) transaktioner på TSE.

Rekommenderas för att spåra öppna transaktioner (alla påbörjade transaktioner måste lagras eller avbrytas).

Avbryter aktiva (påbörjade) transaktioner på TSE.

Returnerar antalet offline-transaktioner (= transaktioner som inte har skickats till TSE på grund av att TSE är offline – ur funktion eller otillgänglig).

Returnerar alla öppna offline-signaturer som lagrats för den aktuella TSE:n.

Bearbetar öppna offline-signaturer.

Ersätter en aktuell TSE för den angivna klienten med en ny (till exempel om den gamla TSE:n är skadad eller certifikatet har gått ut).

Utför ett synkront självtest för den angivna kassan på TSE:n (kassan är valfri).

Uppdaterar firmware på SWISSBIT HARDWARE TSE.

Returnerar de lagrade TicketBAI-filerna (skickade filer, svarsfiler, felrapporter) som en zip-fil.

Returnerar de TicketBAI-filerna för det begärda dokumentnumret (skickade filer, svarsfiler, felrapporter) som en zip-fil.

Laddar upp en digital kvittensfil till Cloud-systemet.

Alternativ: Använd antingen denna eller den alternativa slutpunkten i detta avsnitt för att skicka data om digitala kvitton.

Laddar upp en digital fil till Cloud-systemet. Använder metadata för skattehantering.

Alternativ: Använd antingen denna eller den alternativa slutpunkten i detta avsnitt för att skicka data om digitala kvitton.

Skapar ett dokument vid en redovisningsenhet. Denna metod skapar inte själva dokumentet utan startar endast processen, till exempel på TSE.

Lagrar ett dokument i skatteenheten.

Avbryter ett dokument i skatteenheten.

Metod för att lagra antalet omtryck av ett dokument med hjälp av det lagrade dokumentet (referens: DocumentGuid).

Alternativ: använd istället PUT /api/v1/transactions/reprintDocument

Metod för att lagra antalet utskrifter av ett dokument genom att skicka dokumentet igen. Användaren av det överförda dokumentet måste vara den som gör utskriften (inte användaren av originaldokumentet).

Alternativ: använd alternativt PUT /api/v1/transactions/reprintDocument/
{clientId}/{DocumentGuid}.

Återställer ett dokument (gör alla värden negativa).

Validerar dokumentet och returnerar alla valideringsfel (samt en tom lista om inga valideringsfel finns).

Skicka dokumentet i JSON-format till tjänsten för dokumentvalidering.

Returnerar ett startdokument för den angivna klienten.

Startdokumentet används för att initialisera både klienten och den finansiella enheten (/api/v1/management/clients/initialize).

Visar text på skattekundsdisplayen.

Stöds endast i länder som använder skattekunddisplay. I andra länder har detta anrop ingen effekt (men kan anropas).

Öppnar en kassalåda om en sådan är ansluten till den skattepliktiga skrivaren.

Returnerar QR-koddata som en Base64-kodad string från data.

Lägger till en granskningslogg för den finansiella clienten.

Returnerar alla revisionsposter som söks fram med fromDate/tillDate.

Returnerar det begärda dokumentet om det finns lagrat i det interna lagringsutrymmet.

Returnerar information om huruvida det begärda dokumentet finns i det interna dokumentlagret.

Returnerar det begärda dokumentet om det finns lagrat i det interna lagringsutrymmet.

Returnerar information om huruvida det begärda dokumentet finns i det interna dokumentlagret.

Returnerar det senast lagrade dokumentet från dokumentlagret.

Returnerar det begärda dokumentet om det finns lagrat i det interna lagringsutrymmet.

Returnerar det begärda dokumentsvaret om det finns lagrat i det interna lagringsutrymmet.

Returnerar det begärda dokumentsvaret om det finns lagrat i det interna lagringsutrymmet.

Returnerar det begärda dokumentet om det finns lagrat i det interna lagringsutrymmet.