Lightspeed Restaurant K-Series API documentation

Post proposed order

POST /tp/v1/business-locations/{businessLocationId}/tax-breakdown

OAuth2

Returns the tax breakdown of a proposed order

Path parameters

businessLocationId integer(int64) Required

the id of the businessLocation

Minimum value is 1.

application/json

Body Required

accountProfileCode string

A valid account profile code as setup for this business location.
items array[object]

The items contained in this order
Hide items attributes Show items attributes object
- quantity number(double)
  
  Quantity of item to be ordered
- sku string Required
  
  A stock-keeping unit
  
  Maximum length is 25.
- subItems array[object]
  
  subitems applied to this item
  Hide subItems attributes Show subItems attributes object
  
  quantity number(double)
  
  Quantity of sub-item to be added to the order item
  
  sku string Required
  
  A stock-keeping unit
  
  Maximum length is 25.

Responses

• 200 application/json

Tax Breakdown
Hide response attributes Show response attributes object
- amountDue number
  
  Total cost of order in big decimal format
- taxLines array[object]
  
  Hide taxLines attributes Show taxLines attributes object
  
  description string
  
  Description of the tax to print on the receipt
  
  grossAmount number
  
  Cost of transaction with all taxes applied
  
  netAmount number
  
  Cost of transaction line before taxes are applied
  
  taxAmount number
  
  Cost of all taxes to be applied to this transaction line
  
  taxCode string
  
  Tax code as configured
  
  taxIncluded boolean
  
  taxName string
  
  Tax name as configured
  
  taxRate string
  
  Tax rate as configured, a decimal number encoded in a string, "1.20" means 20% tax
- totalGrossAmountInCents integer(int64)
  
  Total cost of order after all taxes are applied
- totalNetAmountInCents integer(int64)
  
  Total cost of order before taxes are applied
- totalTaxAmountInCents integer(int64)
  
  Cost of all taxes due on the order
- transactions array[object]
  
  Hide transactions attributes Show transactions attributes object
  
  grossAmount number
  
  Cost of transaction with all taxes applied
  
  netAmount number
  
  Cost of transaction line before taxes are applied
  
  quantity number
  
  Quantity of the item on this transaction line
  
  sku string
  
  A stock-keeping unit
  
  Maximum length is 25.
  
  taxAmount number
  
  Cost of all taxes to be applied to this transaction line
  
  unitPrice number
  
  Cost of item
• 400 */*

Bad Request
Hide response attributes Show response attributes object
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  message string
  
  rejectedValue string
- message string
- status string
  
  Value is 400.
- timestamp string(date-time)
• 403 */*

Forbidden
Hide response attributes Show response attributes object
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  message string
  
  rejectedValue string
- message string
- status string
  
  Value is 403.
- timestamp string(date-time)
• 404 */*

Not Found
Hide response attributes Show response attributes object
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  message string
  
  rejectedValue string
- message string
- status string
  
  Value is 404.
- timestamp string(date-time)
• 503 */*

Service Unavailable
Hide response attributes Show response attributes object
- apiSubExceptions array[object]
  
  Hide apiSubExceptions attributes Show apiSubExceptions attributes object
  
  field string
  
  message string
  
  rejectedValue string
- message string
- status string
  
  Value is 503.
- timestamp string(date-time)

POST /tp/v1/business-locations/{businessLocationId}/tax-breakdown

curl \
 -X POST https://api.trial.lsk.lightspeed.app/tp/v1/business-locations/45454565682155/tax-breakdown \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"accountProfileCode":"string","items":[{"quantity":42.0,"sku":"string","subItems":[{"quantity":42.0,"sku":"string"}]}]}'

Request example

{
  "accountProfileCode": "string",
  "items": [
    {
      "quantity": 42.0,
      "sku": "string",
      "subItems": [
        {
          "quantity": 42.0,
          "sku": "string"
        }
      ]
    }
  ]
}

Response examples (200)

{
  "amountDue": 42.0,
  "taxLines": [
    {
      "description": "string",
      "grossAmount": 42.0,
      "netAmount": 42.0,
      "taxAmount": 42.0,
      "taxCode": "string",
      "taxIncluded": true,
      "taxName": "string",
      "taxRate": "string"
    }
  ],
  "totalGrossAmountInCents": 42,
  "totalNetAmountInCents": 42,
  "totalTaxAmountInCents": 42,
  "transactions": [
    {
      "grossAmount": 42.0,
      "netAmount": 42.0,
      "quantity": 42.0,
      "sku": "UGG-BB-PUR-06",
      "taxAmount": 42.0,
      "unitPrice": 42.0
    }
  ]
}