Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Receipts

List Receipts

get/v2/company/{company_id}/receipts

Path parameters

company_idinteger required

Company ID

Query parameters

location_idinteger required

Location ID

receipt_date[gte]string date-time

Return receipts that were created on or after a specific date

receipt_date[lte]string date-time

Return receipts that were created on or before a specific date

modified_sincestring date-time

Return receipts that were modified on or after a specific date

status'open' | 'closed' | 'voided' | 'deleted'

Filter receipts by status type

external_user_idstring

Filter receipts by external user id

cursorstring

An opaque cursor for the next or previous result set.

limitinteger

The number of results desired per page.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Response

OK

object'receipts' required

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"
    }
  ]
}