POST TaxReport/GenerateReportView

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.SalesReport.TaxReport.ReportViewModel
NameDescriptionTypeAdditional information
ReportFormat

IConnect.Domain.Reports.ExportFormat

None.
SelectedCompanies

Collection of integer

None.
OrderSource

IConnect.Domain.Orders.DisplayOrderSource

None.
Start

date

None.
End

date

None.
StartDateObjectString

string

None.
EndDateObjectString

string

None.
SkipTimeZoneConvertion

boolean

None.
ForceImmediateExport

boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "ReportFormat": 1,
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2025-04-03T22:05:31.5586065-04:00",
  "End": "2025-04-03T22:05:31.5586065-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":5,\"seconds\":31,\"miliseconds\":558}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":5,\"seconds\":31,\"miliseconds\":558}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.Domain.Reports.SalesReport.TaxReport.TaxReportResponse
NameDescriptionTypeAdditional information
TaxData

Collection of IConnect.Domain.Reports.SalesReport.TaxReportItem

None.
SoldValueData

Collection of IConnect.Domain.Reports.SalesReport.TaxReportSoldValueItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "TaxData": [
    {
      "CompanyId": 1,
      "Location": "sample string 2",
      "Tax": "sample string 3",
      "Category": "sample string 4",
      "Amount": 5.0,
      "TaxedValue": 6.0
    },
    {
      "CompanyId": 1,
      "Location": "sample string 2",
      "Tax": "sample string 3",
      "Category": "sample string 4",
      "Amount": 5.0,
      "TaxedValue": 6.0
    }
  ],
  "SoldValueData": [
    {
      "CompanyId": 1,
      "Location": "sample string 2",
      "TaxableAmount": 3.0,
      "NonTaxableAmount": 4.0,
      "NonTaxableAmountWoGC": 5.0
    },
    {
      "CompanyId": 1,
      "Location": "sample string 2",
      "TaxableAmount": 3.0,
      "NonTaxableAmount": 4.0,
      "NonTaxableAmountWoGC": 5.0
    }
  ]
}

application/xml, text/xml

Sample: 
<TaxReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport.TaxReport">
  <SoldValueData xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport">
    <d2p1:TaxReportSoldValueItem>
      <d2p1:CompanyId>1</d2p1:CompanyId>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:NonTaxableAmount>4</d2p1:NonTaxableAmount>
      <d2p1:NonTaxableAmountWoGC>5</d2p1:NonTaxableAmountWoGC>
      <d2p1:TaxableAmount>3</d2p1:TaxableAmount>
    </d2p1:TaxReportSoldValueItem>
    <d2p1:TaxReportSoldValueItem>
      <d2p1:CompanyId>1</d2p1:CompanyId>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:NonTaxableAmount>4</d2p1:NonTaxableAmount>
      <d2p1:NonTaxableAmountWoGC>5</d2p1:NonTaxableAmountWoGC>
      <d2p1:TaxableAmount>3</d2p1:TaxableAmount>
    </d2p1:TaxReportSoldValueItem>
  </SoldValueData>
  <TaxData xmlns:d2p1="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.SalesReport">
    <d2p1:TaxReportItem>
      <d2p1:Amount>5</d2p1:Amount>
      <d2p1:Category>sample string 4</d2p1:Category>
      <d2p1:CompanyId>1</d2p1:CompanyId>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:Tax>sample string 3</d2p1:Tax>
      <d2p1:TaxedValue>6</d2p1:TaxedValue>
    </d2p1:TaxReportItem>
    <d2p1:TaxReportItem>
      <d2p1:Amount>5</d2p1:Amount>
      <d2p1:Category>sample string 4</d2p1:Category>
      <d2p1:CompanyId>1</d2p1:CompanyId>
      <d2p1:Location>sample string 2</d2p1:Location>
      <d2p1:Tax>sample string 3</d2p1:Tax>
      <d2p1:TaxedValue>6</d2p1:TaxedValue>
    </d2p1:TaxReportItem>
  </TaxData>
</TaxReportResponse>