POS | Reports

Endpoint for fetching z reports. Reports are fetched from POS connectors if any IZReportFetcher connectors are configured for the tenant.

ToDate will default to DateTime.now and fromDate will default to DateTime.Now.AddDays(-10);

When StoreGroupIds are provided they are expanded to the stores in those groups and merged with any explicitly listed StoreIds before fetching.

Example to fetch the last 10 days of z-reports: { "fromDate": null, "toDate": null, "marketIds": null, "storeIds": null, "storeGroupIds": null }

post/api/ZReport/GetOmniumZReports

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/ZReport/GetOmniumZReports
  • Auth: API key in header Authorization

Request body

fromDatestring date-time
toDatestring date-time
marketIdsstring[] nullable
storeIdsstring[] nullable
storeGroupIdsstring[] nullable

Response

Success

zreportIdstring nullable

Unique identifier for this Z-Report.

companyNamestring nullable

Name of the company operating the store.

storeIdstring nullable

Unique identifier of the store where this report was generated.

storeNamestring nullable

Name of the store where this report was generated.

registerIdstring nullable

Unique identifier of the register (cash register/POS terminal) that generated this report.

dateCreatedstring date-time

Date and time when the Z-Report was created/generated.

vatNumberstring nullable

VAT registration number or company identifier used for tax purposes.

userstring nullable

Name of the staff member who operated the register or generated this report.

currencyCodestring nullable

Primary currency code for this register (ISO 4217 three-letter code, e.g., "USD", "EUR", "SEK").

commentstring nullable

Optional comment or notes entered by staff when closing the register.

receiptCountinteger

Total number of receipts printed during this register period.

drawerOpeningsinteger

Number of times the cash drawer was manually opened (excluding automatic openings during transactions).

salesTotalNetnumber

The net sales amount (excluding VAT/tax).

salesItemsCountinteger

Total number of individual items sold (not transactions, but actual product units).

refundTotalNetnumber

The net refund amount (excluding VAT/tax).

refundItemsCountinteger

Total number of individual items refunded (not transactions, but actual product units).

grandTotalSalesnumber

The total gross money value for all sales.

grandTotalRefundnumber

The total gross money value for all refunds.

roundOffnumber

Rounding adjustment applied to transactions (e.g., for cash payments that need rounding to nearest coin).

summarySalesTaxnumber

Total sales tax/VAT amount in the summary.

summaryRoundOffnumber

Total rounding adjustments in the summary.

summarySubtotalnumber

Subtotal amount before tax and rounding adjustments.

salesTaxesSalesobject[] nullable

Detailed sales tax breakdown for sales transactions (format varies by POS system).

salesTaxesRefundobject[] nullable

Detailed sales tax breakdown for refund transactions (format varies by POS system).

Changes

No recorded changes to this operation across all 1 revision of this API.