This article describes which technical events must be recorded in Québec/Canada.
In accordance with the premise ‘One interface – all countries’, all event entries supported by RetailForce can of course also be recorded in Québec/Canada, but those described below are absolutely essential.
Event entries are transmitted to WEB-SRM in Canada.
| LogEntryType | Code | Mapping WEB-SRM | Description | Trigger |
| DocumentReprintOther | 1 | "modImpr": "FAC" |
Used to record the reprinting of other documents. Use one of the endpoints:
|
automatically when one of the endpoints is called and "documentType" != 0 / "[0] = Receipt" oder 1 "[1] = Invoice" |
| DocumentTrainingModeOn | 10 | “modTrans“: “FOR” | Activate training mode cash register | automatically when transaction is saved with "isTraining" = true |
| DocumentTrainingModeOff | 11 | “modTrans”: “OPE” | Termination of training mode of the cash register | automatically, if a normal transaction ("isTraining" = false) is recorded AFTER a training transaction ("isTraining" = true) |
| DocumentTypeSales | 100 | - | Salestransaction | automatically when a sales transaction is recorded ("businessTransactionType": 0 / Revenue with positive values). |
| DocumentTypeReturn | 101 | - | Returns / Return of goods | automatically when a return transaction is recorded ("businessTransactionType": 0 / Revenue with negative values). |
| DocumentTypeProforma | 102 | - | Proforma document | automatically, if "documentType": 12 / "[12] = ProformaInvoice" and 14 / "[14] = PreliminaryReceipt" |
| DocumentTypeTraining | 104 | - | Training document | automatically when transaction is saved with "isTraining"= true |
| DocumentTypePayOut | 106 | - | Pay out transactions | automatically, if "documentType": 10 / "[10] = PayOut" |
| DocumentTypePayIn | 107 | - | Pay in transactions | automatically, if "documentType": 11 / "[11] = PayIn" |
| DocumentTypeOpeningBalance | 108 | - | Cash registern opening balance | automatically, if "documentType": 90 / "[90] = OpeningBalance" |
| DocumentTypeNullReceipt | 109 | - | Null document | automatically, if "documentType": 1000 / "[1000] = NullReceipt" |
| DocumentTypeInvoice | 110 | - | Invoice | automatically, if "documentType": 1 / "[1] = Invoice" |
| DocumentTypeLongTermOrder | 122 | - | Order document (in Catering industry / HoReCa) | automatically, if "documentType": 80 / "[80] = LongTermOrder" |
| DocumentTypePaymentConfirmation | 123 | - | Payment confirmation | automatically, if "documentType": 15 / "[15] = PaymentReceipt" |
| DocumentReprintLongTermOrder | 140 | "modImpr": "FAC" |
Reprinting an order document in the catering industry
|
automatically when one of the endpoints is called and "documentType": 80 / "[80] = LongTermOrder" |
| DocumentReprintReceipt | 142 | "modImpr": "RPR" |
Used when a sales receipt is reprinted. Use one of the end points:
|
automatically when one of the endpoints is called and
|
| DocumentReprintInvoice | 143 | "modImpr": "RPR" |
Used when an invoice is reprinted. Use one of the endpoints:
|
automatically when one of the endpoints is called and
|
| DocumentDuplicateReceipt | 145 | "modImpr": "DUP" |
Used when a duplicate (retailer copy) of a sales document is created. Use of one of the endpoints:
|
automatically when one of the endpoints is called and
|
| DocumentDuplicateInvoice | 146 | "modImpr": "DUP" |
Used when a duplicate (retailer copy) of an invoice is generated. Use one of the endpoints:
|
automatically when one of the endpoints is called and
|
| DocumentCancelLine | 160 | - | Used when a line has been deleted from the document during the recording process. | automatically if the "deletedPosition" property is set to true. |
| DocumentVoidLine | 161 | - | Used when a line has been voided. | must be sent by the upstream system (NOT automatically) |
| DocumentCancelDocument | 165 | "modImpr": "ANN" oder "PSP" | Used to record the abandonment of a transaction. | automatically when endpoint POST /api/v1/transactions/cancelDocument is called. |
| PrinterUnavailable | 210 | - | Used to record problems with printer communication. | must be sent by the upstream system (NOT automatically) |
| PrinterAvailable | 211 | - | The upstream system must send this entry when printing is possible again, AFTER a previous "PrinterUnavailable". | must be sent by the upstream system (NOT automatically) |
| UserLogin | 400 | - |
User login Attention: As the RetailForce fiscalisation service does not currently support multi-user registration in Canada, only the login of the MAIN user may be recorded. |
must be sent by the upstream system (NOT automatically) |
| UserLogout | 401 | - |
User logout Attention: As the RetailForce fiscalisation service does not currently support multi-user registration in Canada, only the logout of the MAIN user may be recorded. |
must be sent by the upstream system (NOT automatically) |
| ApplicationOfflineModeOn | 550 | - | Used to record problems in WEB-SRM communication. | automatically, if transmission to WEB-SRM is not possible |
| ApplicationOfflineModeOff | 551 | - | Used to record the end of connection problems with WEB-SRM. | automatically, when the connection to WEB-SRM has been re-established |
| FiscalReportUserReport | 1050 | “document”-request |
Used to record the creation of a user report. Use of the endpoint:
|
automatically when the endpoint is called |
| FiscalErrorReceivedFromAuthorities | 1070 | - | Used to record that WEB-SRM has returned an error. | automatically, if WEB-SRM returns an error |
Comments
0 comments
Please sign in to leave a comment.