7S7shifts
Receipts

Create Receipt

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

post/v2/company/{company_id}/receipts

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

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

location_idinteger required

The 7shifts location_id this receipt belongs to

receipt_datestring date-time required

Receipt create date time. UTC date time in ISO8601 format

net_totalinteger required

The net total of the receipt pre tax, post-discounts, pre tips. In cents

gross_totalinteger nullable

The gross total of the receipt in cents

total_receipt_discountsinteger nullable

The total discounts of the receipt in cents

tipsinteger nullable

Total tips in cents

external_user_idstring nullable

External user ID of the sales receipt in your system (must be unique per 7shifts location).

revenue_centerstring nullable

Label for the revenue centre for the receipt

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

Status of the receipt

order_type'dine_in' | 'delivery' | 'take_out' nullable

Order type

dining_optionstring nullable

Dining option

Example request

{
  "receipt_date": "2021-01-01T00:00:00.000Z",
  "tip_details": [
    {
      "value": 500
    }
  ]
}

Response

Created

uuidstring uuid

Changes

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