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

# Get POS totals

> Count, gross, discount, tax and net for a date range, split by payment method. Requires the READ_POS scope.

Every payment method is present in `byPaymentMethod` even when it had no sales, so a till UI can render its four buckets without filling gaps itself.


## OpenAPI

````yaml apps-api/specs/pos.json GET /pos/summary
openapi: 3.1.0
info:
  title: 'Salesive Apps API: Point of Sale'
  version: 1.0.0
  description: >-
    Ring up in-person sales and reconcile them from an installed third-party
    app. Every endpoint authenticates with an installed-app access token (prefix
    `app_`) and requires `READ_POS` or `WRITE_POS`. The target store is bound to
    the token server-side from the installation, so never send a shop id.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
tags:
  - name: Point of sale
    description: In-person sales, their receipts and daily totals.
paths:
  /pos/summary:
    get:
      tags:
        - Point of sale
      summary: Totals for a date range
      description: >-
        Returns the count, gross, discount, tax and net for POS sales in a date
        range, plus the same figures split by payment method. Every method is
        present even when it had no sales. Requires `READ_POS`.
      operationId: getPosSummary
      parameters:
        - name: from
          in: query
          required: false
          description: Inclusive lower bound on the sale date (ISO 8601).
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          required: false
          description: Inclusive upper bound on the sale date (ISO 8601).
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: The totals.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/PosSummary'
        '403':
          description: The app is missing `READ_POS`.
components:
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    PosSummary:
      type: object
      description: >-
        Totals for in-person sales in a date range, plus the same figures split
        by payment method. Every method is present even when it had no sales.
      properties:
        count:
          type: integer
        gross:
          type: number
          description: Sum of sale subtotals before discount and tax.
        discount:
          type: number
        tax:
          type: number
        net:
          type: number
          description: gross - discount + tax, floored at 0.
        byPaymentMethod:
          type: object
          properties:
            cash:
              $ref: '#/components/schemas/PosMethodBucket'
            card:
              $ref: '#/components/schemas/PosMethodBucket'
            transfer:
              $ref: '#/components/schemas/PosMethodBucket'
            other:
              $ref: '#/components/schemas/PosMethodBucket'
    PosMethodBucket:
      type: object
      description: Totals for one payment method.
      properties:
        count:
          type: integer
        gross:
          type: number
        discount:
          type: number
        tax:
          type: number
        net:
          type: number
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side, so never send a shop
        id.

````

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