Receipts

Retrieve Receipt

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

get/v2/company/{company_id}/receipts/{receipt_id}

Request

  • Base URL
    https://api.7shifts.com
  • Auth
    • OAuth 2
      Authorization codehttps://app.7shifts.com/oauth2/authorize
      Client credentials
      Password
      Token URLhttps://app.7shifts.com/oauth2/token
    • or API key in cookie 7session

Path parameters

company_idinteger required

Company ID

receipt_idstring uuid required

Receipt UUID

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": {
    "company_id": 123,
    "pos_id": 1,
    "receipt_id": "RECEIPT001",
    "receipt_date": "2021-01-01T00:00:00.000Z",
    "receipt_close_date": "2021-01-01T00:00:00.000Z",
    "external_user_id": "SCOOBYDOO1",
    "revenue_center": "REV01",
    "receipt_lines": [
      {
        "id": "ABC123",
        "created_date": "2021-01-01T00:00:00.000Z"
      }
    ],
    "tip_details": [
      {
        "value": 500
      }
    ],
    "created_date": "2021-01-01T00:00:00.000Z",
    "modified_date": "2021-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.