indica o país correspondente.

Se as fiscalCountryProperties forem consultadas através de GET /api/v1/information/client/{clientId}/countryProperties, é especificado o país atribuído ao respetivo cliente.

Especifica se é necessária a certificação de um componente de fiscalização num país, ou o que deve ser certificado.

«mandatory» — A certificação do sistema a montante (por exemplo, a caixa registadora) é obrigatória. Neste caso, a caixa registadora deve ser submetida a um processo de certificação ou aprovação.

«miniPOS» — A certificação é obrigatória, mas é cumprida por um componente já certificado que pode ser integrado no RetailForce Middleware.

«notNecessary» — Não é necessária qualquer certificação do sistema anterior.

«true» — no respetivo país, os dados devem ser enviados linha a linha, por exemplo, para uma impressora fiscal.

• Atualmente não suportado

«false» — Interface baseada em documentos (sem impressão linha a linha).

• A implementação entre o sistema a montante e o Serviço de Fiscalização baseia-se em pontos de extremidade api padrão.

Especifica o tipo de fiscalização.

«fiscalPrinter» — A fiscalização baseia-se numa impressora fiscal certificada ou num sistema de caixa registadora fiscal certificado.

• Isto significa que, para além do RetailForce system, é necessária uma impressora fiscal. Esta poderá ter de ser adquirida junto de um fornecedor local.

«online» — Fiscalização através de sistemas online das autoridades fiscais locais.

• Não é necessário qualquer componente de hardware adicional.

«signature» — Fiscalização através da assinatura dos dados dos recibos utilizando um certificado digital armazenado no serviço de fiscalização.

• Em alguns países, poderá ser necessário obter um certificado digital qualificado fornecido por uma CA (Autoridade Certificadora).

«signatureWithOnline» — Fiscalização através da criação de assinaturas e da transmissão de dados online às autoridades fiscais.

• Combinação dos dois tipos acima referidos.

Especifica qual o ambiente suportado:

«local» — instalação local do middleware fiscal (local no sistema de ponto de venda, no servidor da loja, etc.)

• Podem ser efetuadas chamadas de api ao serviço de fiscalização instalado localmente:
  • http://localhost:7678/ no caso da implementação REST, ou
  • chamada de método no caso da implementação via nuget.

«cloud» — o middleware fiscal está disponível como um serviço na nuvem alojado em https://fiscalisation.retailforce.cloud/.

• É possível efetuar chamadas à API do Serviço de Fiscalização na Cloud.

Especifica quais os sistemas operativos/plataformas suportados.

«linux»

• através de um contentor Docker (implementação REST)

«windows»

• através do Serviço do Windows (implementação REST), ou
• através da implementação do nuget

«ios»

• através da implementação do nuget

«android»

• através da implementação do nuget, ou
• Serviço Android (implementação REST)

Especifica quais os requisitos legais suportados e as respetivas versões.

Por exemplo, para a Grécia: «myDATA v1.x.x»

Tipos de documentos que devem ser «fiscalizados» no respetivo país. Por exemplo, devem ser processados pelo componente de hardware prescrito, assinados, etc.

Os «documentTypes» enumerados em «fiscalDocumentTypes» são automaticamente processados (por exemplo, assinados) no respetivo país pelo serviço de fiscalização, em conformidade com a legislação em matéria de fiscalização.

Estes tipos de documentos DEVEM ser transmitidos ao serviço de fiscalização no respetivo país, desde que o sistema a montante («caixa registadora») os suporte.

Lista dos tipos de documentos suportados em cada país.

Para além dos «fiscalDocumentTypes», os tipos de documentos listados em «supportedDocumentTypes» PODEM ser transmitidos ao serviço de fiscalização.

Estes tipos de documentos são os chamados documentos «não fiscais», ou seja, aqueles que não são «fiscalizados» (por exemplo, assinados).

Lista dos tipos de documentos não suportados no respetivo país.

Os «documentTypes» listados em «notSupportedDocumentTypes» não podem ser transmitidos ao serviço de fiscalização no respetivo país.

As razões para tal podem ser a impossibilidade técnica ou regulamentos/leis específicos do país.

Se um «notSupportedDocumentType» for enviado ao serviço de fiscalização, este responderá com uma mensagem de erro («documentType not supported!»).

O sistema a montante não deve permitir estes tipos de documento no país em questão.

Lista dos métodos de pagamento suportados (aceites) no respetivo país.

Estes métodos de pagamento podem ser utilizados no país em questão.

O sistema a montante deve oferecer ao utilizador da caixa registadora apenas os métodos de pagamento suportados no respetivo país.

Lista dos métodos de pagamento que não são suportados (ou não são permitidos) no respetivo país.

O sistema a montante deve suprimir os métodos de pagamento não suportados no respetivo país.

Lista de métodos de pagamento (PaymentTypes) para os quais não é permitido o pagamento de montantes superiores ao valor em dívida no país em questão.

Exemplos:

Total do recibo = 38,50 EUR

• O cliente paga 50 EUR com cartão de débito, pois pretende receber o troco em dinheiro.
• O cliente paga 50 EUR em dinheiro e recebe 11,50 EUR de troco (troco entregue).

Estas transações não são permitidas em alguns países (ou seja, não podem ser enviadas para o sistema de fiscalização).

Isto significa que os montantes de pagamento («payment.amount») devem corresponder sempre ao total bruto dos itens («GrossValue» de todas as «posições») e não podem ser transferidos montantes de pagamento negativos.

Lista dos tipos de casos de negócio suportados em cada país.

Estes casos de negócio podem ser utilizados no respetivo país, ao contrário dos «notSupportedBusinessTransactionTypes».

Lista dos tipos de casos de negócio que não são suportados (ou não são permitidos) no respetivo país.

Estes casos de negócio não podem ser utilizados no respetivo país e devem ser suprimidos pelo sistema de origem e não transmitidos ao serviço de fiscalização.

Informações detalhadas sobre as taxas de Vat suportadas em cada país.

Esta matriz contém as seguintes informações:

• Taxa de IVA: «VatPercent» / «VatPercent2»
• ID interna utilizada para identificar a respetiva taxa de IVA: «VatIdentification»
• Nome da taxa de Vat: «caption» / «caption_EN»
• Taxas de Vat históricas com detalhes de validade («ValidFrom» - «ValidTo»)

«não obrigatório» — A exibição do cliente não é exigida (sem obrigação).

«obrigatório (sem RF)» — A exibição do cliente é obrigatória, mas não é controlada através do RetailForce Middleware. O controlo é efetuado automaticamente pelo respetivo sistema de fiscalização (por exemplo, automaticamente pela impressora fiscal).

«obrigatório (RF)» — É obrigatório utilizar a exibição ao cliente e esta é controlada através do RetailForce Middleware.

• A exibição ao cliente é controlada através da função: POST /api/v1/transactions/display/{clientId}

«não permitido» — A utilização de um ecrã de cliente é proibida neste país.

Especifica se os dispositivos de entrada devem ser registados no respetivo país («true» / «false»).

Os dispositivos de entrada não são sistemas de registo autónomos. Para mais informações, consulte: Arquiteturas de sistemas de registo eletrónico (EAS)

«true» — no respetivo país existe a obrigação de manter um registo técnico (registo de auditoria) (neste caso, incluído na licença RF).

• Neste caso, as entradas de eventos técnicos devem ser enviadas ao serviço de fiscalização através de
  • POST /api/v1/transactions/AuditLog , ou
  • POST /api/v1/transactions/storeDocument ("documentType": "[1002] = AuditLog")

«false» — não existe a obrigação de manter um registo técnico (não incluído na licença).

• Os eventos técnicos PODEM ser registados, mas não são obrigatórios.

«true» — no país em questão, a reimpressão de um documento deve ser registada obrigatoriamente.

• Chamada de uma das seguintes opções:
  • PUT /api/v1/transactions/reprintDocument/ {clientId}/{DocumentGuid}, ou

  • PUT /api/v1/transactions/reprintDocument

    obrigatório.

«false» — A reimpressão de um documento não tem de ser registada como obrigatória.

«terminal» — Um documento só pode ser reimpresso na mesma caixa registadora em que o documento original foi emitido.

«store» — As reimpressões de um documento só podem ser efetuadas na mesma sucursal/loja onde o documento original foi emitido.

• A função de reimpressão entre várias filiais deve ser implementada pelo sistema a montante.

«all» — A reimpressão de um documento pode ser efetuada noutro caixa registador, bem como noutra sucursal/loja da mesma empresa.

• A função de reimpressão entre várias filiais deve ser implementada pelo sistema a montante.

«true» — deve ser gerado um fecho diário (relatório Z) uma vez por dia.

• fecho diário
  • POST /api/v1/transactions/storeDocument
  • «documentType»: «[99] = EndOfDay»

"false" — não é exigido um fecho diário.

Indica o período de tempo, a partir da abertura diária da caixa registadora, dentro do qual deve ocorrer um fecho diário (por exemplo, no prazo de 24 horas).

"-1" - não definido.

Especifique se as vendas e as devoluções podem ser registadas simultaneamente num recibo (documento).

«oneReceiptAllowed» — permitido (as vendas e as devoluções podem ser apresentadas em conjunto num único recibo).

• Vendas:
  • «positions» (Tipo 0 ou 1) com valores positivos,
• Devoluções:
  • «positions» (Tipo 0 ou 1) com valores negativos e
  • "documentReference" definido.

«oneReceiptAllowedVat» — desde que o montante do Vat se mantenha positivo, as vendas e as devoluções podem ser registadas num único (o mesmo) recibo.

«multiReceipt» — As vendas e as devoluções devem ser registadas em recibos diferentes.

• Antes de transmitir os dados ao serviço de fiscalização, o sistema a montante deve dividir automaticamente as vendas e as devoluções em transações distintas.

«NoReturnAllowed» — no país em questão, não é possível processar devoluções através do sistema de fiscalização. Nestes países, as devoluções são frequentemente tratadas através de formulários especiais ou similares no departamento de contabilidade.

Onde podem ser devolvidos os artigos adquiridos?

«terminal» — Os artigos só podem ser devolvidos no mesmo balcão de caixa (emissão do recibo) onde a venda original foi efetuada.

«store» — Os artigos só podem ser devolvidos na mesma filial/loja (emissão do recibo) onde a venda original foi efetuada.

«all» — Os artigos também podem ser devolvidos em filiais diferentes da mesma empresa.

Referência do documento para devoluções

«único» — no caso de devoluções, só pode ser feita referência a UM documento anterior (documento de venda dos serviços ou bens devolvidos).

• «documentReference» só é permitido para um único documento preliminar, ou
• a referência ao nível do item («positionReference») só é permitida para um único documento preliminar.

«multiple» — no caso de devoluções, podem ser feitas referências a vários documentos anteriores (vários recibos de venda, caso sejam devolvidos vários serviços ou bens provenientes de várias compras). 

• «documentReference» para vários documentos anteriores, ou
• referência ao documento anterior correspondente através de «positionReference» no item individual da devolução.

Especifica se o elemento «fiscalDocumentNumber» da «fiscalResponse» do país correspondente deve ser impresso nos documentos.

• Os números de documento transferidos do sistema a montante são ignorados. O sistema fiscal (por exemplo, a impressora) atribui o respetivo número de documento/ID do documento de forma autónoma.

«true» — no país em questão, são permitidas sobretaxas sobre bens ou serviços.

• sobretaxas:
  • «positions.discounts» com valores NEGATIVOS

«false» — Não são permitidas sobretaxas de preço.

Indica se o modo de formação/demonstração da caixa registadora é permitido no respetivo país

«true» — permitido.

• Modo de formação:
  • «IsTraining»: true

«false» — A caixa registadora não deve dispor de um modo de formação/demonstração.

"true" — A soma dos itens individuais é calculada com base no valor líquido (NetValue) (por exemplo, Québec/Canadá).

"false" - A soma dos itens individuais é calculada com base no valor bruto (GrossValue) (predefinição).

«true» — Os itens que foram introduzidos, mas que posteriormente não foram incluídos no documento, devem ser transmitidos na payload (JSON).

«false» — Os itens que foram introduzidos, mas que posteriormente não foram incluídos no documento, não precisam de ser transmitidos.

Especifica o tipo de documento inicial no país em questão.

Apenas relevante se o sistema a montante NÃO utilizar a função GET /api/v1/transactions/document/{clientId}/start durante a inicialização e gerar ele próprio o respetivo documento inicial.

Lista dos tipos de pagamento suportados no país em questão.

Os itens listados em «supportedPayOutTypes» podem/devem ser especificados para pagamentos («documentType»: «[10] = PayOut» e «BusinessTransactionType»: «[10] = PayOut»).

Indica se as taxas de Vat são calculadas pelo respetivo módulo de fiscalização do país.

«true» — O módulo de fiscalização calcula as taxas de Vat.

«false» — a caixa registadora deve calcular as taxas de Vat.

Especifica se e quantas casas decimais devem ser incluídas no documento JSON enviado ao middleware fiscal ao transmitir montantes/totais.

Aplica-se a todas as especificações de valor na payload («GrossValue», «NetValue», «TaxValue», «Amount», etc.)