> ## Documentation Index
> Fetch the complete documentation index at: https://developers.xfaster.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Daily report

> One business day (06:00 to 06:00), with the same numbers the store sees in the XFaster tablet's Z report, without commission. Use it to check your Z against XFaster.



## OpenAPI

````yaml GET /reports/daily
openapi: 3.1.0
info:
  title: XFaster Partner API
  version: '1.0'
  description: >
    Receive XFaster orders in your POS, send their status back, and keep the
    menu, stock and prices in sync.

    One API key per store, or one integrator key for all your stores (it names
    the store in X-XFaster-Store). Money is in agorot (integers, VAT included).
    Times are ISO 8601 with the Israel offset.
servers:
  - url: https://staging2.xfaster.net/api/partner/v1
    description: Sandbox (test keys, xfp_test_…)
  - url: https://apps.xfaster.net/api/partner/v1
    description: Live (live keys, xfp_live_…)
security:
  - apiKey: []
  - apiKey: []
    storeHeader: []
tags:
  - name: Store
  - name: Orders
  - name: Menu
  - name: Market
  - name: Reports
  - name: Sandbox
paths:
  /reports/daily:
    get:
      tags:
        - Reports
      summary: Daily report
      description: >-
        One business day (06:00 to 06:00), with the same numbers the store sees
        in the XFaster tablet's Z report, without commission. Use it to check
        your Z against XFaster.
      operationId: dailyReport
      parameters:
        - name: date
          in: query
          description: The business day. Default today so far.
          schema:
            type: string
            format: date
            example: '2026-10-14'
      responses:
        '200':
          description: The day
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DailyReport'
              examples:
                example:
                  $ref: '#/components/examples/DailyReport'
        '422':
          $ref: '#/components/responses/Invalid'
components:
  schemas:
    DailyReport:
      type: object
      properties:
        date:
          type: string
          format: date
          example: '2026-10-14'
        from:
          type: string
          format: date-time
        to:
          type: string
          format: date-time
        complete:
          type: boolean
          description: true once the day has ended
        invoices:
          type: string
          enum:
            - xfaster
            - store
        orders:
          type: object
          properties:
            completed:
              type: integer
              example: 58
            refunded:
              type: integer
              example: 1
            cancelled:
              type: integer
              example: 3
            open:
              type: integer
              example: 0
        totals:
          type: object
          properties:
            sales:
              type: integer
              example: 412050
            gross_sales:
              type: integer
            discounts:
              type: integer
            refunded_sales:
              type: integer
            tax:
              type: integer
            packaging:
              type: integer
            delivery:
              type: integer
            tips:
              type: integer
            currency:
              type: string
              example: ILS
        by_type:
          type: object
          properties:
            pickup:
              $ref: '#/components/schemas/ReportRow'
            delivery:
              $ref: '#/components/schemas/ReportRow'
        collected:
          type: object
          properties:
            store_cash:
              type: integer
              example: 61000
            store_card:
              type: integer
              example: 0
            courier_cash:
              type: integer
              example: 190050
            xfaster:
              type: integer
              example: 161000
            other:
              type: integer
              example: 0
        cash_in_drawer:
          type: integer
          example: 61000
    ReportRow:
      type: object
      properties:
        orders:
          type: integer
        total:
          type: integer
        cash:
          type: integer
        electronic:
          type: integer
        other:
          type: integer
        uncollected:
          type: integer
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type:
                - object
                - 'null'
  examples:
    DailyReport:
      value:
        date: '2026-10-14'
        from: '2026-10-14T06:00:00+03:00'
        to: '2026-10-15T06:00:00+03:00'
        complete: true
        invoices: xfaster
        orders:
          completed: 58
          refunded: 1
          cancelled: 3
          open: 0
        totals:
          sales: 412050
          gross_sales: 431050
          discounts: 19000
          refunded_sales: 4200
          tax: 0
          packaging: 0
          delivery: 0
          tips: 0
          currency: ILS
        by_type:
          pickup:
            orders: 14
            total: 98000
            cash: 61000
            electronic: 37000
            other: 0
            uncollected: 0
          delivery:
            orders: 44
            total: 314050
            cash: 190050
            electronic: 124000
            other: 0
            uncollected: 0
        collected:
          store_cash: 61000
          store_card: 0
          courier_cash: 190050
          xfaster: 161000
          other: 0
        cash_in_drawer: 61000
  responses:
    Invalid:
      description: A value is missing or breaks a rule
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: prep_time_out_of_range
              message: Preparation time must be between 5 and 120 minutes.
              details:
                min: 5
                max: 120
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        The store's API key (xfp_test_… on the sandbox, xfp_live_… on live).
        XFaster creates it and shows it once. An integrator key (one key for a
        POS company) also sends X-XFaster-Store.
    storeHeader:
      type: apiKey
      in: header
      name: X-XFaster-Store
      description: >-
        Integrator keys only: the XFaster store id this request is for. It must
        be linked to your key (else 403 store_not_linked); without it 400
        store_header_required. Store keys don't send it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.