Sign in

v1

latestOpenAPI 3.0.22026-07-24154101.1 MB
Receipts

Update Receipt

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

Path parameters

company_idinteger required

Company ID

receipt_idstring required

Receipt ID. Either 7shifts receipt UUID or a combination of the External ID of the sales receipt in your system and a Location ID. External ID's must start with 'ext:' and the format is ext:location_id:receipt_id.

Headers

x-api-versionstring

An API version

Example:2022-05-01

7shifts API version

x-company-guidstring uuid

Company GUID

Request body

receipt_datestring date-time

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

The gross total of the receipt in cents

total_receipt_discountsinteger

The total discounts of the receipt in cents

tipsinteger

Total tips in cents

external_user_idstring

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

revenue_centerstring

Label for the revenue center for the receipt

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

Status of the receipt

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

Order type

dining_optionstring

Dining option

Example request

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

Response

The receipt update is queued for processing

object'receipt_processed' required

Example response

{
  "data": {
    "uuid": "de9cc3bc-9508-4a1a-807c-b70fc4c9e372",
    "receipt_id": "RECEIPT001"
  }
}