Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Receipts

Retrieve Receipts Summary

get/v2/company/{company_id}/receipts_summary

Path parameters

company_idinteger required

Company ID

Query parameters

location_idinteger required

Location ID

receipt_date[gte]string date

Return receipts that were created on or after a specific date. Limit to 31-day range with receipt_date[lte].

receipt_date[lte]string date

Return receipts that were created on or before a specific date. Limit to 31-day range with receipt_date[gte].

modified_sincestring date

Return receipts that were modified on or after a specific date. Limited to past 30 days. If set, receipt_date[gte] and receipt_date[lte] are ignored.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

Example response

{
  "data": [
    {
      "open": {
        "receipt_count": 100,
        "net_total": 100,
        "gross_total": 100,
        "tip_total": 100,
        "receipt_discounts": 100
      },
      "closed": {
        "receipt_count": 100,
        "net_total": 100,
        "gross_total": 100,
        "tip_total": 100,
        "receipt_discounts": 100
      },
      "voided": {
        "receipt_count": 100,
        "net_total": 100,
        "gross_total": 100,
        "tip_total": 100,
        "receipt_discounts": 100
      },
      "deleted": {
        "receipt_count": 100,
        "net_total": 100,
        "gross_total": 100,
        "tip_total": 100,
        "receipt_discounts": 100
      }
    }
  ]
}