Objeto fiscalResponse «fiscalResponse» – RetailForce

Este artigo descreve o objeto fiscalResponse («posições») no âmbito do objeto Document (objeto Document
).

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

O objeto fiscalResponse é devolvido ao sistema a montante (caixa registadora, sistema de registo eletrónico) como resposta a uma transmissão bem-sucedida do documento (createDocument e storeDocument).

O objeto fiscalResponse é composto por:

Informações padrão — informações independentes do respetivo país (fiscal) (iguais para todos os países)
Informações específicas do país — determinadas informações que devem ser impressas num recibo no país em questão ou armazenadas no diário. Estas informações são devolvidas na matriz «AdditionalFields» do objeto fiscalResponse.

Objeto fiscalResponse

O objeto a seguir contém dados de exemplo.

{
   "fiscalCountry": "[0] = Germany",
   "fiscalisationDocumentNumber": 52,
   "fiscalDocumentNumber": "52",
   "fiscalDocumentStartTime": 1674819139,
   "processStartTime": 0,
   "errorDescription": null,
   "cashRegisterId": "00345-00345",
   "signature": "pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==",
   "userMessage": null,
   "printMessage": "***Test***",
   "requestTime": "2023-01-27T12:34:21.3088836+01:00",
   "requestCompletionTime": "2023-01-27T12:34:22.4379009+01:00",
   "retailForceReceiptId": "0p4j0001",    /// only for createDocument
   "AdditionalFields": {
      "QrCodeDataString": "V0;00345-00345;Kassenbeleg-V1;Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar;52;197;2023-01-27T11:32:19.000Z;2023-01-27T11:34:20.000Z;ecdsa-plain-SHA256;unixTime;pCeGi98gNNhshcGJkbw0DwtSzuJkaawON8l5QwsFDEaDHOyYK2aNVO4ZAlpkYYnub7oxM/2R1/KB36UzmOQwew==;BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TransactionStartTime": 1674819139,
      "TransactionEndTime": 1674819260,
      "ProcessData": "Beleg^13.90_0.00_0.00_0.00_0.00^13.90:Unbar",
      "ProcessType": "Kassenbeleg-V1",
      "TseSerial": "e5f5836a57c50c526d4bed37f18823608f2f44e2c98cab73278a7676c5ea0885",
      "TseTimeFormat": "unixTime",
      "TseHashAlgorithm": "ecdsa-plain-SHA256",
      "TsePublicKey": "BNHckCuXF2fEktIp8qwtnMLLgvpJDX6wEOqFENlHXZpekBHxHniQh9gbigjWS9UbCwZSrOTJTMK7WiV5owAfXkk=",
      "TseSignatureCounter": 197,
      "TseCertificate": "MIIB0jCCAVmgAwIBAgIhAOX1g2pXxQxSbUvtN/GII2CPL0TiyYyrcyeKdnbF6giFMAoGCCqGSM49BAMDMDExFTATBgNVBAoTDGZpc2thbHkgR21iSDEYMBYGA1UEAxMPZmlza2FseSBUZXN0IENBMB4XDTIyMTAzMDEyMjgzMloXDTIzMTAzMDEyMjgzMlowMjEVMBMGA1UEChMMZmlza2FseSBHbWJIMRkwFwYDVQQDExBmaXNrYWx5IFRlc3QgVFNFMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE0dyQK5cXZ8SS0inyrC2cwsuC+kkNfrAQ6oUQ2Uddml6QEfEeeJCH2BuKCNZL1RsLBlKs5MlMwrtaJXmjAB9eSaNBMD8wDgYDVR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUlllBymQBup6ldKGojZVpZtWG5tQwCgYIKoZIzj0EAwMDZwAwZAIwEFsoSON9cIBqA5d9vsGI2jSjDlZxHokDvJ4yBmayvigrDbdhMYe3hw3HyQbO2B/FAjBXSVNbYR6Wg2TVzL9BhCla+tewRDGcs6vnetJ4i3VRtya1+ejt+vRjWnb/RUyo0Uw=",
      "fiscalDocumentRevision": 2
   }
}

O objeto fiscalResponse contém as seguintes informações.

Informações na coluna «Type»:

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
fiscalCountry			Indicador do respetivo país fiscal. Enumeração: [0] = Alemanha [1] = Áustria [2] = França [3] = Bulgária [4] = Dinamarca [5] = Suécia [6] = Eslovénia [7] = Polónia [8] = Sérvia [9] = Itália [10] = Croácia [12] = Roménia [15] = Lituânia [16] = Hungria [18] = Espanha [99999] = Sem fiscalização
fiscalisationDocumentNumber			Número do documento fiscal (atribuído pelo respetivo sistema fiscal — por exemplo, TSE na Alemanha). Valor inteiro Nota: Obsoleto; será substituído pela propriedade de tipo string «fiscalDocumentNumber» em versões futuras.
fiscalDocumentNumber			Número do documento fiscal (atribuído pelo respetivo sistema fiscal — por exemplo, TSE na Alemanha). Detalhes por país: Alemanha: a propriedade fiscalDocumentNumber (e o seu valor) da fiscalResponse, após a chamada à função createDocument , deve ser incluída no documento JSON a enviar para a função storeDocument . Nota: Introduzido na versão 1.7.7. Ao contrário de fiscalisationDocumentNumber, fiscalDocumentNumber é um elemento do tipo «string»
~~fiscalisationDocumentRevision~~			Número de revisão do documento fiscal. (é atribuído pelo respetivo sistema fiscal — TSE na Alemanha). Atenção: a propriedade «fiscalisationDocumentRevision» foi removida do header do objeto fiscalResponse com a release 1.7.7. A propriedade foi renomeada para «fiscalDocumentRevision» e agora só é devolvida como parte dos «AdditionalFields» do fiscalResponse-Alemanha !
TaxPositions			Indicação de todas as posições de Vat do documento.
	VatIdentification		ID Indicador da taxa de Vat do item de Vat. Item
	VatLabel
	VatPercent1		Taxa de imposto, em percentagem, desta posição de Vat. Posição (neste caso, a posição de Vat 1)
	VatAmount		Montante do Vat da posição de Vat
	NetAmount		Montante líquido (sem Vat) da posição de Vat
	GrossAmount		Montante bruto (incluindo Vat) da posição de Vat
fiscalDocumentStartTime			Hora de criação do documento fiscal — carimbo de data/hora Unix (atribuído pelo respetivo sistema fiscal — por exemplo, TSE na Alemanha).
processStartTime			Hora de criação do primeiro documento no âmbito de todo o processo (por exemplo, na Alemanha: hora de criação da primeira encomenda do cliente relacionada com o presente documento de pagamento — ver também «características da restauração»).
ErrorDescription			Descrição do erro caso o processo de fiscalização tenha falhado. Vazio caso não tenha ocorrido qualquer erro.
cashRegisterId			Devolve o número da caixa registadora sob o qual o documento fiscal foi registado/processado.
signature			Assinatura do documento, criada pelo respetivo sistema de fiscalização (por exemplo, dispositivo de criação de assinaturas na Áustria, TSE na Alemanha...)
UserMessage			Notificação que deve ser apresentada ao utilizador do sistema de ponto de venda. Atenção: em alguns países, uma eventual mensagem de utilizador deve ser apresentada ao caixa. Recomendamos a implementação deste procedimento para cada país fiscal.
PrintMessage			Deve ser impressa no documento (por exemplo, «recibo de caixa»), caso contrário, existe o risco de a implementação não estar em conformidade com os requisitos legais do respetivo país. Consulte também «PrintMessage». Atenção: em alguns países, as informações devolvidas através do elemento PrintMessage devem ser impressas no recibo. Recomendamos a implementação deste procedimento para cada país fiscal.
requestTime			Devolve a hora do pedido
requestCompletionTime			Devolve a hora em que o pedido foi concluído pelo sistema fiscal
retailForceReceiptId			ID de documento globalmente único atribuído pelo RetailForce system. Apenas é devolvido na resposta fiscalResponse ao chamar PUT /api/v1/transactions/createDocument. Nota: Para que o retailForceReceiptId seja gerado, este deve ser ativado uma vez para o respetivo cliente através da chamada à função POST /api/v1/management/clients/ {clientId}/GlobalShortId . Para mais informações, consulte o artigo «ID global da caixa registadora e ID global do documento».
AdditionalFields			Informações específicas do país
	{...}		fiscalResponseAustria fiscalResponseBulgaria fiscalResponseCanada respostafiscalCroácia RespostaOrçamentalDinamarca RespostaOrçamentalFrança resposta fiscal na Alemanha resposta fiscal Grécia RespostaOrçamental da Hungria RespostaOrçamentalItália RespostaOrçamental da Lituânia respostaOrçamentalPolónia respostaOrçamentalRoménia respostaOrçamentalSérvia RespostaOrçamentalEslováquia RespostaOrçamentalEslovénia resposta fiscal Espanha resposta fiscal na Suécia

Este artigo foi traduzido automaticamente.

Objeto fiscalResponse

Artigos relacionados