---
title: "List Receipts"
method: GET
path: "/v2/company/{company_id}/receipts"
tags: ["Receipts"]
---

# List Receipts

`GET /v2/company/{company_id}/receipts`

## Request

- Base URL: `https://api.7shifts.com`
- URL: `https://api.7shifts.com/v2/company/{company_id}/receipts`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://app.7shifts.com/oauth2/authorize`
    - Client credentials
    - Password
    - Token URL: `https://app.7shifts.com/oauth2/token`
  - API key in cookie `7session`

Deprecated: Do not use this endpoint for new integrations. Existing integrations should migrate to the List Orders endpoint to retrieve sales data. This endpoint will be removed in a future release.

## Path parameters

- `company_id` integer, required

## Query parameters

- `location_id` integer, required
- `receipt_date[gte]` string, date-time
- `receipt_date[lte]` string, date-time
- `modified_since` string, date-time
- `status` 'open' | 'closed' | 'voided' | 'deleted'
- `external_user_id` string
- `cursor` string
- `limit` integer

## Headers

- `x-api-version` string: An API version
- `x-company-guid` string, uuid

## Response `200`

OK

- object
  - `object` 'receipts', required
  - `data` object[], required
    - `uuid` string, uuid
    - `company_id` integer: The id of the company
    - `location_id` integer, required: The id of the location where this receipt was created
    - `pos_id` integer: The ID of the POS system that generated the receipt
    - `receipt_id` string, required: ID available to the client in the POS UI. Be it a GUID, a receipt number, a composite of date and ID and terminal, etc
    - `receipt_date` string, date-time: ISO8601 date and time in UTC when receipt was created
    - `receipt_close_date` string, date-time: ISO8601 date and time in UTC when receipt was closed
    - `net_total` integer, required: Net total of the receipt in cents, pre tax, post-discounts, pre tips
    - `gross_total` integer: Gross total of the receipt in cents
    - `tips` integer: Total tips in cents
    - `total_receipt_discounts` integer: Total receipt discounts in cents
    - `total_item_discounts` integer: Item discounts in cents
    - `external_user_id` string, nullable: ID available to the client in the POS UI. Representing the user responsible for creation of receipt.
    - `revenue_center` string, nullable: ID of the revenue center
    - `receipt_lines` object[]: Receipt line items
      - `id` string, nullable: Internal UUID of the receipt
      - `location_id` integer, required: The id of the location where this receipt was created
      - `external_item_id` string, required: The item ID available to the client
      - `external_category_ids` string[], required: The list of category IDs available to the client
      - `quantity` integer, required: Quantity of this item
      - `price` integer, required: Price in cents
      - `gross_item_price` integer, nullable: The item gross price in cents
      - `net_item_price` integer, nullable: The item net price pre-tax, post-discounts, pre-tips. In cents
      - `item_discount` integer, nullable: The item discount in cents
      - `created_date` string, date-time, nullable: ISO8601 date and time in UTC when receipt was created in 7shifts system
    - `tip_details` object[]: Tip line items
      - `type` 'cc' | 'cash' | 'declared' | 'net' | 'total' | 'gratuity', required: Tip type
      - `value` integer, required: Tip value. In cents
    - `status` 'open' | 'closed' | 'voided' | 'deleted': Status of the receipt
    - `created_date` string, date-time: ISO8601 date and time in UTC when receipt was created in 7shifts system
    - `modified_date` string, date-time: ISO8601 date and time in UTC when receipt was last updated in 7shifts system
  - `meta` object, required
    - `cursor` object, required
      - `current` string, nullable, required: The current cursor.
      - `prev` string, nullable, required: A cursor for navigating to the previous page.
      - `next` string, nullable, required: A cursor for navigating to the next page.
      - `count` integer, nullable, required: The total items in the current cursor.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable Entity
- `500`: Unexpected error

---

[API](https://skmtc.dev/7shifts/apis/7shifts-api.md) - [All operations](https://skmtc.dev/7shifts/apis/7shifts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/7shifts/apis/7shifts-api/revisions/40e0ef40dfcd?raw)