Post proposed order
POST
/tp/v1/business-locations/{businessLocationId}/tax-breakdown
Returns the tax breakdown of a proposed order
Path parameters
-
businessLocationId integer(int64) Required
the id of the businessLocation
Minimum value is
1
.
Body Required
-
accountProfileCode string
A valid account profile code as setup for this business location.
-
items array[object]
The items contained in this order
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
}
]
}