Skip to main content

Back-office Reports

A Back-office Report (documento gestionale) is a non-fiscal document issued by a PEM. It gives the Merchant a readable view of the PEM's fiscal activity: sales totals, receipt details, and the PEM's operational status.

Back-office reports are not commercial documents, so they are not sent to the Italian Tax Authority. Every report is a PDF signed with the PEM's certificate, so you can check that it really was issued by that PEM and has not been changed.

Report types​

There are five types of back-office report:

TypeGeneratedRequires an open journalWhat it shows
journal_closureAutomatically, when a journal is closed—The final sales totals of the journal that has just been closed
journal_readingOn requestYesThe current sales totals of the journal that is still open
diagnosticsOn requestYesThe PEM's current status and communication data
detailsOn requestNoThe line-by-line content of one or more receipts
summaryOn requestNoTotals for a set of receipts, grouped by VAT treatment

Journal closure​

A journal-closure report is created every time the PEM's active journal is closed. This happens both when the journal is closed explicitly and when it is closed automatically 24 hours after the first commercial document of the fiscal day. You cannot request this report yourself.

The report contains:

  • one section per fiscal day included in the journal, with the sales totals for that day
  • the PEM's grand total (gran totale), updated with the sales of the closed journal
  • the number of commercial documents in the journal

Journal reading​

A journal-reading report is a snapshot of the PEM's currently open journal. You can request one at any time during the fiscal day to check sales so far without closing the journal.

It has the same layout as the journal-closure report. Its grand total is the PEM's current grand total plus the sales recorded in the open journal so far.

You can only request it while the PEM has an open journal.

Diagnostics​

A diagnostics report shows the PEM's current state when the report is requested. In particular, it shows the following information:

  • the current status (i.e. online, activated, ...) and when it last changed
  • Merchant and Supplier details
  • the fiscal software's code, name, approval reference and version
  • receipts not yet sent to MF2 (count and total amount), and the last successful transmission
  • the last transmission of daily receipts to the Italian Tax Authority, and its outcome
  • the last lottery transmission and the last lottery secret request, with their outcomes
  • the last messages received from MF2 and from the Italian Tax Authority
  • a warning if the PEM will be blocked within the next 10 minutes because MF2 cannot be reached (see Outage)

Receipt details​

A details report lists the full content of one or more receipts: line items, payments, VAT summary, and any lottery codes.

You can request the details of

  • a single receipt.
  • all the receipts within a specified document numbers interval, as long as the extremes belong to the same journal.
  • all the receipts within a specified dates interval. In this case the API will retrieve receipts that belong to any daily report that MF2 has generated between the two specified dates.

One details request can produce more than one report:

  • a separate report is produced for each journal the selected receipts belong to
  • each report covers at most 100 receipts; larger sets are split into several reports

Receipt summary​

A summary report aggregates a set of receipts into totals. It includes:

  • VAT totals, grouped by VAT rate, exemption type (natura), or ventilazione IVA. If the Merchant is associated with more than one ATECO code, these totals are further broken down by ATECO code.
  • Payment totals, split into cash, electronic payments, discounts, and uncollected amounts.

You can request a summary of

  • all the receipts within a specified document numbers interval, as long as the extremes belong to the same journal.
  • all the receipts within a specified dates interval. In this case the API will summarize receipts that belong to any daily report that MF2 has generated between the two specified dates. The report has one section per journal and day, plus a total for the whole period.

A summary request always produces exactly one report.

Requests and reports​

Reports are generated asynchronously. You create a request, and the platform turns it into one or more reports in the background.

All paths below are relative to /v1/mf1/pems/{serial_number}.

The example uses a details request, but each report is queued with its own endpoint.

GET /backoffice-reports/requests lists the PEM's requests. Once a request has been processed, it includes a reports object that shows progress:

FieldMeaning
countHow many reports were created for the request
ready_countHow many of them can be downloaded
readytrue when every report for the request can be downloaded

To find the reports created for a request, call GET /backoffice-reports?request_uuid={request_uuid}. Download each one with GET /backoffice-reports/{report_uuid}/pdf.

Request lifecycle​

Report lifecycle​

You can only download a report's PDF when it is in the ready state.

Document number​

Every back-office report has a document number in the format NNNN-NNNN:

  • The first part is the journal the report belongs to. This is the PEM's open journal or, if no journal is open, the next journal that will be opened.
  • The second part counts the back-office reports issued within that journal.

The document number is assigned when the PDF is generated, so it is null while the report is queued or processing.

Retention​

PDFs are kept for 7 days after they are issued and are then deleted permanently. If you need to keep them longer, download them and store them yourself.