Gå til hovedindhold

Betalingsobjekt »payments«

Harald Krondorfer
  • Opdateret

Denne artikel omhandler Payment-objektet („payments“) inden for Document-objektet.

En fuldstændig beskrivelse af RetailForce DOM (Document Object Model) samt en beskrivelse af de enkelte elementer findes i downloadområdet på RetailForce website (Object model documentation.pdf) i det respektive versionsbibliotek.

Betalingsobjektet kan naturligvis indeholde flere forskellige betalinger (= forskellige betalingsmåder – PaymentType) for en enkelt bilag.

betalingsobjekt

Følgende betalingsobjekt indeholder eksempeldata.

"payments": [
    {
      "amount": 120.00,
      "currencyIsoCode": "EUR",
      "caption": "BAR",
      "uniqueReadablePaymentIdentifier": "BARZAHLUNG",
      "foreignAmount": 0,
      "foreignAmountExchangeRate": 0,
      "additionalFields": {
        "voucherId": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "paymentType": "cash",
      "createDate": "2023-04-25T15:08:11.57+01:00",
      "vatIdentification": 1,
      "vatPercent": 20,
      "vatPercent2": 10,
      "taxValue": 20.00,
      "taxValue2": 10.00,
      "externalIdentifier": [
        "string"
      ],
      "user": {
        "id": "user01",
        "caption": "user01",
        "firstName": "Manuela",
        "lastName": "Musterfrau",
        "taxNumber": "123456789"
      },
      "salesPerson": {
        "id": "VK01",
        "caption": "Franz",
        "firstName": "Franz",
        "lastName": "Österreicher",
        "taxNumber": "234567890"
      },
      "paymentTerminalReferenceId": "string",
      "cardData": {
        "receiptCopyCount": 2,
        "receipt": ["line1", "line2"],
        "cardNumberMasked": "****1234",
        "identificationToken": "token123",
        "merchantCopyCount": 1,
        "merchantReceipt": ["merchant line1"],
        "cardType": "VISA",
        "authorizationCode": "AUTH123",
        "terminalId": "TERM001",
        "merchantId": "MERCH001",
        "transactionId": "TRX123456",
        "providerSignature": "signature_string",
        "providerTransactionId": "PROV_TRX_001",
        "providerSignatureMessage": "signature_message",
        "transactionDate": "2023-04-25T15:08:11.57+01:00",
        "transactionNumber": "12345"
      }
    }
  ],

Følgende betalingsobjekt indeholder eksempeldata.

Oplysninger i kolonnen "Type":

  • M ... obligatorisk / påkrævet
  • M* ... obligatorisk / påkrævet i visse lande eller under visse betingelser
  • R ... anbefalet
  • O... valgfrit
Elementer Type Beskrivelse
mængde M Samlet beløb for betalingspositionen
CurrencyIsoCode M ISO 4217-valutakode
caption M Betegnelse for betalingsmetoden / betalingsmidlet
UniqueReadablePaymentIdentifier M

(vilkårlig) unik identifikator for betalingstypen.

Eksempler:

"kontanter", "kontantbetaling", "VISA", "kontanter-EUR",...

Bemærk: Det er ikke muligt at anvende to forskellige valutaforkortelser for den samme UniqueReadablePaymentIdentifier inden for én daglig opgørelse (Z-rapport)! Hvis der anvendes flere valutaer, skal der anvendes en UniqueReadablePaymentIdentifier for hver valuta. F.eks. "KontanterEUR", "KontanterUSD", "KontanterDKK", "Kontantbetaling EUR",...
ForeignAmount O

Samlet beløb, hvis betalingen foretages i en fremmed valuta
ForeignAmountExchangeRate O

Valutakurs for udenlandsk valuta
AdditionalFields M*

 
  VoucherId M*

Typer: MultiPurposeVoucher, SinglePurposeVoucher. Bemærk: VoucherId skal være indlejret under AdditionalFields objektet.
  additionalProp1-x M*

 
PaymentType M

Betalingsmetode / Betalingsmiddel
IsCash -

elementet "IsCash" understøttes ikke længere fra og med 1. marts 2023. Betalingsform defineres af elementet PaymentType.

OBS: Egenskaben "IsCash" er blevet fjernet fra og med Fiscal Client version 1.7.6!
CreateDate O

Dato, hvor betalingstypen blev oprettet (hvis tilgængelig)
VatIdentification M*

Momsidentifikations-ID (i henhold til RF-tildeling), se: GET /api/v1/information/client/ {clientId}/getVatIdentification

Bemærk: For visse betalingstyper skal der angives oplysninger om Vat. For eksempel ved forskud (depositum), værdikuponer osv.
Vi anbefaler, at du altid angiver Vat-oplysninger.
VatPercent M*

Vat-procent / -sats
VatPercent2 O

Anden Vat-procent / sats (ved betalinger med blandede Vat-satser)
TaxValue M*

Momsbeløb
TaxValue2 O

Andet Vat-beløb (ved betalinger med blandet Vat-sats)
ExternalIdentifier O

 
bruger O/M*

Oplysninger om kasseapparatets bruger (kan angives, hvis disse adskiller sig fra oplysningerne i headeret eller i linjeposterne).
  ID O/M*

ID-kode for kassebrugeren
  caption O/M*

Betegnelse for kasseapparatbrugeren
  firstName O

Fornavn på kasseapparatets bruger
  lastName O

Efternavn på kassebrugeren
  taxNumber O/M*

Kasseoperatørens skattenummer

Landespecifikationer: I visse lande (f.eks. Slovenien) skal kasseoperatørens skattenummer angives.
SalesPerson O/M*

Oplysninger om SalesPersonen (kan angives, hvis disse adskiller sig fra oplysningerne i headeren eller i de enkelte varelinjer)
  ID O/M*

SalesPersons ID-nummer
  caption O/M*

SalesPersons titel
  firstName O

SalesPersons fornavn
  lastName O

SalesPersons efternavn
  taxNumber O/M*

SalesPersons skattenummer

Landespecifikationer: I visse lande (f.eks. Slovenien) skal kassererens skattenummer angives.
PaymentTerminalReferenceId O/M*

Transaktions-ID returneret af betalingsterminalen (hvis betalingsterminalen er integreret med POS-systemet, og transaktions-ID'et skal udskrives på dokumentet).

Landespecifikationer:
cardData O

Kvitteringer fra kreditkortterminaler (uden egen udskrivningsfunktion) kan integreres i en kvittering via cardData.

I lande, hvor der anvendes "fiskale printere" (= RetailForce systemet styrer udskrivningen af dokumenter), udskrives oplysningerne i cardData-området som fritekstlinjer efter den fiskale kvittering. Der er ingen adskillelse mellem de to dele.

Landespecifikke oplysninger:

  • Grækenland: Der kræves yderligere felter til elektronisk betalingsbehandling i Grækenland, herunder ProviderSignature, ProviderTransactionId og ProviderSignatureMessage for at overholde lokale regler.
  ReceiptCopyCount O

Antal kvitteringskopier
  kvittering O

Array med kvitteringstekstlinjer
  CardNumberMasked O

Maskere kortnummer af sikkerhedshensyn (f.eks. ****1234)
  IdentificationToken O

Unikt identifikations-token for transaktionen
  MerchantCopyCount O

Antal kopier af kvitteringen til forretningen
  MerchantReceipt O

Array med tekstlinjer på forhandlerkvitteringen
  CardType O

Korttypen for betalingstransaktionen (f.eks. VISA, MASTERCARD osv.)
  AuthorizationCode O

Autorisationskoden for betalingen
  terminalId O

Terminalens ID til betalingen
  MerchantId O

Forhandlerens ID (fra indløseren)
  transactionId O

Unikt ID for transaktionen
  ProviderSignature O/M*

Betalingsudbyderens signatur til betalingsprocessen i Grækenland
  ProviderTransactionId O/M*

Betalingsudbyderens transactionId til betalingsprocessen i Grækenland
  ProviderSignatureMessage O/M*

Betalingsudbyderens signaturmeddelelse til betalingsprocessen i Grækenland
  TransactionDate O

Datoen for betalingstransaktionen
  TransactionNumber O

Transaktionsnummeret for den elektroniske betaling

 

Bemærk: Fra den 1. marts 2023 er feltet "IsCash" blevet fjernet fra objektmodellen. Det kan stadig overføres, men udløser ikke længere en funktion. Betalingstyper styres via feltet "PaymentType".

 

Denne artikel er oversat automatisk.

Relaterede artikler

Kommentarer

0 kommentarer

Log ind for at kommentere.

Drevet af Zendesk