Post proposed order

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

Returns the tax breakdown of a proposed order

Path parameters

application/json

Body Required

  • 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
    • sku string Required

      A stock-keeping unit

      Maximum length is 25.

    • quantity number(double)

      Quantity of item to be ordered

    • subItems array[object]

      subitems applied to this item

      Hide subItems attributes Show subItems attributes object
      • sku string Required

        A stock-keeping unit

        Maximum length is 25.

      • quantity number(double)

        Quantity of sub-item to be added to the order item

Responses

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":[{"sku":"string","quantity":42.0,"subItems":[{"sku":"string","quantity":42.0}]}]}'
Request example
{
  "accountProfileCode": "string",
  "items": [
    {
      "sku": "string",
      "quantity": 42.0,
      "subItems": [
        {
          "sku": "string",
          "quantity": 42.0
        }
      ]
    }
  ]
}
Response examples (200)
{
  "transactions": [
    {
      "sku": "UGG-BB-PUR-06",
      "quantity": 42.0,
      "unitPrice": 42.0,
      "netAmount": 42.0,
      "grossAmount": 42.0,
      "taxAmount": 42.0
    }
  ],
  "taxLines": [
    {
      "description": "string",
      "taxRate": "string",
      "taxCode": "string",
      "taxName": "string",
      "netAmount": 42.0,
      "grossAmount": 42.0,
      "taxAmount": 42.0,
      "taxIncluded": true
    }
  ],
  "totalNetAmountInCents": 42,
  "totalGrossAmountInCents": 42,
  "totalTaxAmountInCents": 42,
  "amountDue": 42.0
}
Response examples (400)
{
  "status": "400",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}
Response examples (403)
{
  "status": "403",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}
Response examples (404)
{
  "status": "404",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}
Response examples (503)
{
  "status": "503",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}