POST api/OmsReporting/financials/sales-tax-by-locale

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
ReportStart	date	None.
ReportEnd	date	None.
SiteId	integer	None.
SearchByInvoiceDate	boolean	None.
LocaleId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ReportStart": "2025-12-20T23:46:32.0557856+00:00",
  "ReportEnd": "2025-12-20T23:46:32.0557856+00:00",
  "SiteId": 3,
  "SearchByInvoiceDate": true,
  "LocaleId": 5
}

application/xml, text/xml

Sample:

<SalesTaxByLocaleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <LocaleId>5</LocaleId>
  <ReportEnd>2025-12-20T23:46:32.0557856+00:00</ReportEnd>
  <ReportStart>2025-12-20T23:46:32.0557856+00:00</ReportStart>
  <SearchByInvoiceDate>true</SearchByInvoiceDate>
  <SiteId>3</SiteId>
</SalesTaxByLocaleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReportingSalesTaxModelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	ReportingSalesTaxModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "CurrentSite": 1,
    "TimezoneHourOffset": 2,
    "Sites": null,
    "Locales": [
      {
        "Value": 1,
        "Text": "sample string 2",
        "Code": "sample string 3"
      },
      {
        "Value": 1,
        "Text": "sample string 2",
        "Code": "sample string 3"
      }
    ],
    "ReportStartDate": "sample string 3",
    "ReportEndDate": "sample string 4",
    "SearchByInvoiceDate": true,
    "DataItems": null,
    "LocaleID": 6,
    "Locale": "sample string 7",
    "CurrentCulture": null,
    "EnableExport": true
  }
}

application/xml, text/xml

Sample:

<ReportingSalesTaxModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:CurrentCulture xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Globalization" i:nil="true" />
    <d2p1:CurrentSite>1</d2p1:CurrentSite>
    <d2p1:DataItems i:nil="true" />
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:Locale>sample string 7</d2p1:Locale>
    <d2p1:LocaleID>6</d2p1:LocaleID>
    <d2p1:Locales>
      <d2p1:ValueTextModel>
        <d2p1:Code>sample string 3</d2p1:Code>
        <d2p1:Text>sample string 2</d2p1:Text>
        <d2p1:Value>1</d2p1:Value>
      </d2p1:ValueTextModel>
      <d2p1:ValueTextModel>
        <d2p1:Code>sample string 3</d2p1:Code>
        <d2p1:Text>sample string 2</d2p1:Text>
        <d2p1:Value>1</d2p1:Value>
      </d2p1:ValueTextModel>
    </d2p1:Locales>
    <d2p1:ReportEndDate>sample string 4</d2p1:ReportEndDate>
    <d2p1:ReportStartDate>sample string 3</d2p1:ReportStartDate>
    <d2p1:SearchByInvoiceDate>true</d2p1:SearchByInvoiceDate>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:TimezoneHourOffset>2</d2p1:TimezoneHourOffset>
  </Model>
  <ResponseCode>Success</ResponseCode>
</ReportingSalesTaxModelResponse>