In this article you will learn how to query the different properties of the countries and also how to find them in the RetailForce cloud. At the end of the article you will find an explanation of the different elements of the fiscalCountryProperties.
In order to illustrate the necessary implementations for your implementation, the country properties (FiscalCountryProperties) were created. These show which parts of the overall interface must at least be implemented for each country.
The country properties are available from version V1.2.12 (except client from V1.2.13).
Query the country properties in the cloud
The country properties can be accessed in the Cloud Portal under the following link:
https://portal.retailforce.cloud/information/fiscal-country
To access the FiscalCountryProperties, you must be logged in to the portal.
Query the country properties on the client
The country properties can also be queried via the programme. This makes it possible to react to various country properties in the cash register programme.
Example: a document type is not allowed in a country and is therefore not supported.
Query via direct implementation (nuget)
To query all existing country properties of all countries, the following method can be called:
List<IFiscalCountryProperties> TrustedFiscalModul.GetFiscalCountryPropertiesList()
Query via client
Rest Service
At the REST service there are 2 endpoints to query the country properties:
GET /api/v1/information/countryProperties
This method can be used to query the country properties for a country.
/api/v1/information/client/{clientId}/countryProperties
This method can be used to query the country properties for a client.
Fiscal Service client
On the Fiscal Service client (.net Standard 2.0 and .net Framework 2) there are the following methods to query the country properties.
FiscalCountryProperties GetFiscalCountryProperties(FiscalCountry fiscalCountry)
This method can be used to query the country properties for a country.
FiscalCountryProperties GetFiscalCountryProperties(Guid clientId)
This method can be used to query the country properties for a client.
fiscalCountryProperties - Explanation
| Actual country module version | Current version of the Trusted Fiscal Country Module within the middleware (relevant for countries in which a specific software version must be certified; e.g. France). |
| Line interface |
"true" - in the respective country, data must be sent line by line e.g. to a fiscal printer. "false" - Document-based interface (no line-by-line printing). |
| Customer Display |
"not mandatory" - Customer display is not required (no obligation). "mandatory (no-RF)" - Customer display is mandatory, but is not controlled via RetailForce Middleware. "mandatory (RF)" - It is mandatory to use a customer display must and it is controlled via the RetailForce middleware. "not allowed" - Use of a customer display is prohibited in this country. |
| Audit log mandatory |
"true" - in the respective country there is a requirement to keep a technical journal (audit log) (in this case included in the RF licence). "false" - there is no requirement to keep a technical journal (not included in licence). |
| Must record document reprints |
"true" - in the corresponding country, the reprint of a document must be recorded obligatorily (call of the endpoint: PUT /api/v1/transactions/reprintDocument/ {clientId}/{documentGuid} obligatory!). "false" - Reprinting of a document does not have to be recorded as mandatory. |
| Reprint allowed domain |
"terminal" - A document may only be reprinted on the same cash register on which the original document was issued. "store" - Reprints of a document may only be made within the same branch /store where also the original document was issued. "all" - Reprinting of a document may be done on another cash register as well as in another branch / store of the same company. |
| Must send closing per day |
"true" - a daily closing (Z-report) must be generated once a day. "false" - no requirement for a daily closing. |
| Maximum hour interval for closing |
Indicates the period of time since the cash register daily opening within which a daily closing must take place (e.g. within 24h). "-1" - not set. |
| Return and sale behavior |
Specify whether sales and returns may be recorded simultaneously on a receipt (document). "oneReceiptAllowed" - allowed (sales and returns can be shown mixed on one receipt). "oneReceiptAllowedVat" - as long as the VAT amount remains positive, sales and returns can be recorded on a single (the same) receipt. "multiReceipt" - Sales and returns must be recorded on different receipts. "NoReturnAllowed" - in the respective country, returns processing via the fiscalization system is not possible. In these countries, returns are often handled via special forms or similar in the accounting department. |
| Return reference behavior |
Document reference for returns "single" - in the case of returns, reference may only be made to ONE previous document (sales document of the returned services or goods). "multiple" - in case of returns, references to multiple previous documents (multiple sales receipts if multiple services or goods from multiple purchases are returned) may be made. |
| Allowed return domain |
Where may purchased items be returned? "terminal" - Items may only be taken back at the same cash desk (voucher issue) at which the original sale was made. "store" - Items may only be returned to the same branch /store (voucher issue) where the original sale was made. "all" - Items may also be returned to different branches of the same company. |
| Surcharges possible |
"true" - in the respective country, surcharges on goods or services are permitted. "false" - Price surcharges are not allowed. |
| Trainingmode allowed |
Indicates whether a training / demo mode of the cash register is permitted in the respective country "true" - allowed. "false" - Cash register must not have a training / demo mode. |
| Fiscal module calculates tax rates |
Indicates whether the VAT rates are calculated by the respective fiscalisation module of the country. "true" - Fiscalisation module calculates VAT rates. "false" - cash register must calculate VAT rates. |
| Amount decimal places |
Specifies whether and how many decimal places must be included in the JSON-document to the Fiscal Middleware when sending amounts / totals. |
| Fiscal document types |
Document types that are to be "fiscalised" in the respective country. For example, they must be processed by the prescribed hardware component, signed, etc. |
| Document types (supported/not supported) |
Document types supported in the respective country. "supported" - These document types can be transmitted. "not supported" - these document types cannot be transmitted (error message!). |
| Payment types (supported/not supported) |
Payment methods supported in the respective country. "supported" - these payment methods can be transmitted (are permitted in the respective country). "not supported" - these payment methods cannot be transmitted (are not permitted in the respective country, for example). |
| Business transaction types (supported/not supported) |
Business transaction types supported in the respective country. "supported" - these business transaction types can be transmitted (are permitted in the respective country). "not supported" - these business transaction types cannot be transmitted (e.g. are not permitted in the respective country). |
Comments
0 comments
Please sign in to leave a comment.