POST v2/TaxCalculation

Returns applicable taxes for the Catalog Items in the body of the call. Only valid for Tax Exclusive locations, which apply taxes in addition to the selling price.

Information:

Base URL:

https://api.covasoft.net/taxes

Request Information

URI Parameters

None.

Body Parameters

The Catalog Items you want to get the Taxes for see above for Example

TEPTaxCalculationRequest

Name	Type	Additional information
CompanyId	integer	None.
EntityId	integer	None.
LineItems	Collection of LineItem	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyId": 1,
  "EntityId": 2,
  "LineItems": [
    {
      "LineNumber": 1,
      "ProductCatalogId": "0c45106f-e5ab-44b0-808f-d1bc4ea576de",
      "Quantity": 3.1,
      "Price": 4.1,
      "BasePriceListPrice": 5.1
    },
    {
      "LineNumber": 1,
      "ProductCatalogId": "0c45106f-e5ab-44b0-808f-d1bc4ea576de",
      "Quantity": 3.1,
      "Price": 4.1,
      "BasePriceListPrice": 5.1
    }
  ]
}

Response Information

Resource Description

The Taxes for the Catalog Items

TEPTaxCalculationResult

Name	Type	Additional information
Id	globally unique identifier	None.
SaleId	globally unique identifier	None.
CompanyId	integer	None.
EntityId	integer	None.
LineItems	Collection of TaxLineItem	None.
Status	string	None.
TaxCalculationDateUtc	date	None.
TaxTotals	Collection of Object	None.
TotalTaxAmount	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "02d82a1e-faf8-4020-96bf-0b24c4fe8e7c",
  "SaleId": "588183bc-24fe-4fbd-aca9-6d667c72af14",
  "CompanyId": 3,
  "EntityId": 4,
  "LineItems": [
    {
      "LineNumber": "sample string 1",
      "ProductCatalogId": "1beabe27-7fd5-4d2c-b279-9e8d1c89ef06",
      "Quantity": 3.1,
      "Price": 4.1,
      "Tax": 5.1,
      "UnroundedTax": 6.1,
      "Taxable": 7,
      "TaxDetails": [
        {},
        {}
      ]
    },
    {
      "LineNumber": "sample string 1",
      "ProductCatalogId": "1beabe27-7fd5-4d2c-b279-9e8d1c89ef06",
      "Quantity": 3.1,
      "Price": 4.1,
      "Tax": 5.1,
      "UnroundedTax": 6.1,
      "Taxable": 7,
      "TaxDetails": [
        {},
        {}
      ]
    }
  ],
  "Status": "sample string 5",
  "TaxCalculationDateUtc": "2024-11-07T08:57:55.0999896+00:00",
  "TaxTotals": [
    {},
    {}
  ],
  "TotalTaxAmount": 7.1
}