Objeto de pagamento «payments» – RetailForce

Este artigo diz respeito ao objeto «Pagamento» («payments») no âmbito do objeto «Documento».

Uma descrição completa do RetailForce DOM (Modelo de Objetos de Documento), bem como uma descrição dos elementos individuais, pode ser consultada na área de downloads do RetailForce website (Documentação do modelo de objetos.pdf) no respetivo diretório de versões.

O objeto «pagamento» pode, naturalmente, conter vários pagamentos diferentes (= diferentes meios de pagamento — «PaymentType») para um único comprovativo.

objeto-pagamentos

O objeto de pagamento a seguir contém dados de exemplo.

"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"
      }
    }
  ],

O objeto de pagamento a seguir contém dados de exemplo.

Informações na coluna «Tipo»:

M ... obrigatório / exigido
M* ... obrigatório / exigido em determinados países ou sob determinadas condições
R ... recomendado
O... opcional

Elementos		Tipo	Descrição
quantidade		M	Total da posição de pagamento
CurrencyIsoCode		M	Código de moeda ISO 4217
caption		M	Designação do método de pagamento / meio de pagamento
UniqueReadablePaymentIdentifier		M	identificador único (arbitrário) do tipo de pagamento. Exemplos: «dinheiro», «pagamento em dinheiro», «VISA», «dinheiro-EUR»,... Atenção: não é possível utilizar duas abreviaturas de moeda diferentes para o mesmo UniqueReadablePaymentIdentifier num único extrato diário (relatório Z)! Caso sejam utilizadas várias moedas, deve ser utilizado um UniqueReadablePaymentIdentifier único para cada moeda. Por exemplo: «CashEUR», «CashUSD», «CashDKK», «pagamento em dinheiro EUR»,...
ForeignAmount		O	Total se o pagamento for efetuado numa moeda estrangeira
ForeignAmountExchangeRate		O	Taxa de câmbio da moeda estrangeira
AdditionalFields		M*
	VoucherId	M*	Tipos: MultiPurposeVoucher, SinglePurposeVoucher. Atenção: `VoucherId` deve estar aninhado sob o `AdditionalFields` objeto.
	additionalProp1-x	M*
PaymentType		M	Método de pagamento / Meios de pagamento
~~IsCash~~		-	O elemento «IsCash» deixou de ser suportado a partir de 1 de março de 2023. O tipo de pagamento é definido pelo elemento PaymentType. Atenção: A propriedade «IsCash» foi removida a partir da versão 1.7.6 do Fiscal Client!
CreateDate		O	Data em que o tipo de pagamento foi criado (se disponível)
VatIdentification		M*	ID da classe de Vat (de acordo com a atribuição RF), consulte: GET /api/v1/information/client/ {clientId}/getVatIdentification Atenção: Para determinados tipos de pagamento, é necessário fornecer informações relativas ao Vat. Por exemplo, para adiantamentos (depósito), vales, etc. Recomendamos que inclua sempre os detalhes relativos ao Vat.
VatPercent		M*	Percentagem / taxa de Vat
VatPercent2		O	Segunda percentagem / taxa de Vat (para pagamentos com taxas de Vat mistas)
TaxValue		M*	Montante do Vat
TaxValue2		O	Segundo montante de Vat (para pagamentos com taxas de Vat mistas)
ExternalIdentifier		O
utilizador		O/M*	Dados do utilizador da caixa registadora (podem ser especificados caso sejam diferentes dos dados constantes no header do documento ou nas partidas individuais).
	ID	O/M*	ID do utilizador da caixa registadora
	caption	O/M*	Designação do utilizador da caixa registadora
	firstName	O	Nome próprio do utilizador da caixa registadora
	lastName	O	Apelido do utilizador da caixa registadora
	taxNumber	O/M*	Número de identificação fiscal do utilizador da caixa registadora Dados do país: em determinados países (por exemplo, na Eslovénia), o número de identificação fiscal do caixa deve ser indicado.
SalesPerson		O/M*	Dados do SalesPerson (podem ser indicados caso sejam diferentes dos dados constantes no header do documento ou nas partidas individuais)
	ID	O/M*	ID do vendedor
	caption	O/M*	Cargo do SalesPerson
	firstName	O	Nome próprio do SalesPerson
	lastName	O	Apelido do SalesPerson
	taxNumber	O/M*	Número de identificação fiscal do SalesPerson Dados do país: em determinados países (por exemplo, Eslovénia), o número de identificação fiscal do caixa deve ser indicado.
PaymentTerminalReferenceId		O/M*	ID da transação devolvida pelo terminal de pagamento (caso o terminal de pagamento esteja integrado com o sistema POS e a ID da transação deva ser impressa no documento). Detalhes por país: Dinamarca: o PaymentTerminalReferenceId deve ser incluído no pedido no caso de pagamentos com cartão. Para mais informações, consulte o ponto 7 dos requisitos aplicáveis às caixas registadoras na Dinamarca .
cardData		O	Os recibos provenientes de terminais de cartão de crédito (sem função de impressão própria) podem ser integrados num recibo através de cardData. Nos países onde são utilizadas «impressoras fiscais» (= o RetailForce system controla a impressão de documentos), a informação incluída na área cardData é impressa como linhas de texto livre a seguir ao recibo fiscal. Não existe separação entre as duas partes. Detalhes por país: Grécia: São necessários campos adicionais para o processamento de pagamentos eletrónicos na Grécia, incluindo ProviderSignature, ProviderTransactionId e ProviderSignatureMessage, para cumprimento da regulamentação local.
	ReceiptCopyCount	O	Número de cópias do recibo
	recibo	O	Matriz de linhas de texto do recibo
	CardNumberMasked	O	Número do cartão mascarado por motivos de segurança (por exemplo, ****1234)
	IdentificationToken	O	Token de identificação único para a transação
	MerchantCopyCount	O	Número de cópias do recibo do comerciante
	MerchantReceipt	O	Matriz de linhas de texto do recibo do comerciante
	CardType	O	O tipo de cartão da transação de pagamento (por exemplo, VISA, MASTERCARD, etc.)
	AuthorizationCode	O	O código de autorização para o pagamento
	terminalId	O	O ID do terminal de pagamento
	MerchantId	O	O ID (atribuído pelo adquirente) do comerciante
	transactionId	O	ID único da transação
	ProviderSignature	O/M*	A assinatura do prestador de serviços de pagamento para o processo de pagamento na Grécia
	ProviderTransactionId	O/M*	O «transactionId» do prestador de serviços de pagamento para o processo de pagamento na Grécia
	ProviderSignatureMessage	O/M*	A mensagem de assinatura do prestador de serviços de pagamento para o processo de pagamento na Grécia
	TransactionDate	O	A data da transação de pagamento
	TransactionNumber	O	O número da transação de pagamento eletrónico

Nota: A partir de 1 de março de 2023, o campo «IsCash» foi removido do modelo de objeto. Continua a poder ser transmitido, mas já não aciona nenhuma função. Os tipos de pagamento são controlados através do campo «PaymentType».

Este artigo foi traduzido automaticamente.

objeto-pagamentos

Artigos relacionados