POST api/OmsReporting/financials/sales-by-day

Request Information

URI Parameters

None.

Body Parameters

SiteStartEndDateRequest

NameDescriptionTypeAdditional Information
StartDate

date

None.

EndDate

date

None.

SiteId

integer

None.

SearchByInvoiceDate

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDate": "2025-12-20T16:59:10.3655913+00:00",
  "EndDate": "2025-12-20T16:59:10.3655913+00:00",
  "SiteId": 1,
  "SearchByInvoiceDate": true
}

application/xml, text/xml

Sample:
<SiteStartEndDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <EndDate>2025-12-20T16:59:10.3655913+00:00</EndDate>
  <SearchByInvoiceDate>true</SearchByInvoiceDate>
  <SiteId>1</SiteId>
  <StartDate>2025-12-20T16:59:10.3655913+00:00</StartDate>
</SiteStartEndDateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReportingModelResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Model

ReportingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "Sites": null,
    "CurrentSiteId": 1,
    "CurrentSite": null,
    "ReportDateLocal": "sample string 2",
    "IsDaily": true,
    "CurrentWeek": {
      "StartDay": "2025-12-20T16:59:10.3655913+00:00",
      "EndDay": "2025-12-20T16:59:10.3655913+00:00",
      "SalesCount": [
        1,
        2
      ],
      "SalesAmount": [
        1.0,
        2.0
      ],
      "FormattedSalesCount": [
        "sample string 1",
        "sample string 2"
      ],
      "FormattedSalesAmount": [
        "sample string 1",
        "sample string 2"
      ],
      "StartDayFormatted": "sample string 3",
      "EndDayFormatted": "sample string 4"
    },
    "Minus1Week": {
      "StartDay": "2025-12-20T16:59:10.3655913+00:00",
      "EndDay": "2025-12-20T16:59:10.3655913+00:00",
      "SalesCount": [
        1,
        2
      ],
      "SalesAmount": [
        1.0,
        2.0
      ],
      "FormattedSalesCount": [
        "sample string 1",
        "sample string 2"
      ],
      "FormattedSalesAmount": [
        "sample string 1",
        "sample string 2"
      ],
      "StartDayFormatted": "sample string 3",
      "EndDayFormatted": "sample string 4"
    },
    "Minus2Week": {
      "StartDay": "2025-12-20T16:59:10.3655913+00:00",
      "EndDay": "2025-12-20T16:59:10.3655913+00:00",
      "SalesCount": [
        1,
        2
      ],
      "SalesAmount": [
        1.0,
        2.0
      ],
      "FormattedSalesCount": [
        "sample string 1",
        "sample string 2"
      ],
      "FormattedSalesAmount": [
        "sample string 1",
        "sample string 2"
      ],
      "StartDayFormatted": "sample string 3",
      "EndDayFormatted": "sample string 4"
    },
    "Minus3Week": {
      "StartDay": "2025-12-20T16:59:10.3655913+00:00",
      "EndDay": "2025-12-20T16:59:10.3655913+00:00",
      "SalesCount": [
        1,
        2
      ],
      "SalesAmount": [
        1.0,
        2.0
      ],
      "FormattedSalesCount": [
        "sample string 1",
        "sample string 2"
      ],
      "FormattedSalesAmount": [
        "sample string 1",
        "sample string 2"
      ],
      "StartDayFormatted": "sample string 3",
      "EndDayFormatted": "sample string 4"
    },
    "AverageWeek": {
      "StartDay": "2025-12-20T16:59:10.3655913+00:00",
      "EndDay": "2025-12-20T16:59:10.3655913+00:00",
      "SalesCount": [
        1,
        2
      ],
      "SalesAmount": [
        1.0,
        2.0
      ],
      "FormattedSalesCount": [
        "sample string 1",
        "sample string 2"
      ],
      "FormattedSalesAmount": [
        "sample string 1",
        "sample string 2"
      ],
      "StartDayFormatted": "sample string 3",
      "EndDayFormatted": "sample string 4"
    },
    "ReportHeaderFormat": "sample string 4",
    "StartYear": 5,
    "YearCount": 6,
    "MonthlyDetails": {
      "1": [
        {
          "m_Item1": 1,
          "m_Item2": 2.0
        },
        {
          "m_Item1": 1,
          "m_Item2": 2.0
        }
      ],
      "2": [
        {
          "m_Item1": 1,
          "m_Item2": 2.0
        },
        {
          "m_Item1": 1,
          "m_Item2": 2.0
        }
      ]
    },
    "MonthlyDetailsFormatted": {
      "1": [
        {
          "m_Item1": 1,
          "m_Item2": "sample string 2"
        },
        {
          "m_Item1": 1,
          "m_Item2": "sample string 2"
        }
      ],
      "2": [
        {
          "m_Item1": 1,
          "m_Item2": "sample string 2"
        },
        {
          "m_Item1": 1,
          "m_Item2": "sample string 2"
        }
      ]
    },
    "EnableExport": true,
    "EnableOrdering": true
  }
}

application/xml, text/xml

Sample:
<ReportingModelResponse 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:AverageWeek>
      <d2p1:EndDay>2025-12-20T16:59:10.3655913+00:00</d2p1:EndDay>
      <d2p1:EndDayFormatted>sample string 4</d2p1:EndDayFormatted>
      <d2p1:FormattedSalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesAmount>
      <d2p1:FormattedSalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesCount>
      <d2p1:SalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </d2p1:SalesAmount>
      <d2p1:SalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesCount>
      <d2p1:StartDay>2025-12-20T16:59:10.3655913+00:00</d2p1:StartDay>
      <d2p1:StartDayFormatted>sample string 3</d2p1:StartDayFormatted>
    </d2p1:AverageWeek>
    <d2p1:CurrentSite i:nil="true" />
    <d2p1:CurrentSiteId>1</d2p1:CurrentSiteId>
    <d2p1:CurrentWeek>
      <d2p1:EndDay>2025-12-20T16:59:10.3655913+00:00</d2p1:EndDay>
      <d2p1:EndDayFormatted>sample string 4</d2p1:EndDayFormatted>
      <d2p1:FormattedSalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesAmount>
      <d2p1:FormattedSalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesCount>
      <d2p1:SalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </d2p1:SalesAmount>
      <d2p1:SalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesCount>
      <d2p1:StartDay>2025-12-20T16:59:10.3655913+00:00</d2p1:StartDay>
      <d2p1:StartDayFormatted>sample string 3</d2p1:StartDayFormatted>
    </d2p1:CurrentWeek>
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:EnableOrdering>true</d2p1:EnableOrdering>
    <d2p1:IsDaily>true</d2p1:IsDaily>
    <d2p1:Minus1Week>
      <d2p1:EndDay>2025-12-20T16:59:10.3655913+00:00</d2p1:EndDay>
      <d2p1:EndDayFormatted>sample string 4</d2p1:EndDayFormatted>
      <d2p1:FormattedSalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesAmount>
      <d2p1:FormattedSalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesCount>
      <d2p1:SalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </d2p1:SalesAmount>
      <d2p1:SalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesCount>
      <d2p1:StartDay>2025-12-20T16:59:10.3655913+00:00</d2p1:StartDay>
      <d2p1:StartDayFormatted>sample string 3</d2p1:StartDayFormatted>
    </d2p1:Minus1Week>
    <d2p1:Minus2Week>
      <d2p1:EndDay>2025-12-20T16:59:10.3655913+00:00</d2p1:EndDay>
      <d2p1:EndDayFormatted>sample string 4</d2p1:EndDayFormatted>
      <d2p1:FormattedSalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesAmount>
      <d2p1:FormattedSalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesCount>
      <d2p1:SalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </d2p1:SalesAmount>
      <d2p1:SalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesCount>
      <d2p1:StartDay>2025-12-20T16:59:10.3655913+00:00</d2p1:StartDay>
      <d2p1:StartDayFormatted>sample string 3</d2p1:StartDayFormatted>
    </d2p1:Minus2Week>
    <d2p1:Minus3Week>
      <d2p1:EndDay>2025-12-20T16:59:10.3655913+00:00</d2p1:EndDay>
      <d2p1:EndDayFormatted>sample string 4</d2p1:EndDayFormatted>
      <d2p1:FormattedSalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesAmount>
      <d2p1:FormattedSalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:FormattedSalesCount>
      <d2p1:SalesAmount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </d2p1:SalesAmount>
      <d2p1:SalesCount xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SalesCount>
      <d2p1:StartDay>2025-12-20T16:59:10.3655913+00:00</d2p1:StartDay>
      <d2p1:StartDayFormatted>sample string 3</d2p1:StartDayFormatted>
    </d2p1:Minus3Week>
    <d2p1:MonthlyDetails xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintArrayOfTupleOfintdecimalU6ho3Bhd>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:TupleOfintdecimal>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>2</d5p1:m_Item2>
          </d5p1:TupleOfintdecimal>
          <d5p1:TupleOfintdecimal>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>2</d5p1:m_Item2>
          </d5p1:TupleOfintdecimal>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfTupleOfintdecimalU6ho3Bhd>
      <d3p1:KeyValueOfintArrayOfTupleOfintdecimalU6ho3Bhd>
        <d3p1:Key>2</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:TupleOfintdecimal>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>2</d5p1:m_Item2>
          </d5p1:TupleOfintdecimal>
          <d5p1:TupleOfintdecimal>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>2</d5p1:m_Item2>
          </d5p1:TupleOfintdecimal>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfTupleOfintdecimalU6ho3Bhd>
    </d2p1:MonthlyDetails>
    <d2p1:MonthlyDetailsFormatted xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintArrayOfTupleOfintstringU6ho3Bhd>
        <d3p1:Key>1</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:TupleOfintstring>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>sample string 2</d5p1:m_Item2>
          </d5p1:TupleOfintstring>
          <d5p1:TupleOfintstring>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>sample string 2</d5p1:m_Item2>
          </d5p1:TupleOfintstring>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfTupleOfintstringU6ho3Bhd>
      <d3p1:KeyValueOfintArrayOfTupleOfintstringU6ho3Bhd>
        <d3p1:Key>2</d3p1:Key>
        <d3p1:Value xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:TupleOfintstring>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>sample string 2</d5p1:m_Item2>
          </d5p1:TupleOfintstring>
          <d5p1:TupleOfintstring>
            <d5p1:m_Item1>1</d5p1:m_Item1>
            <d5p1:m_Item2>sample string 2</d5p1:m_Item2>
          </d5p1:TupleOfintstring>
        </d3p1:Value>
      </d3p1:KeyValueOfintArrayOfTupleOfintstringU6ho3Bhd>
    </d2p1:MonthlyDetailsFormatted>
    <d2p1:ReportDateLocal>sample string 2</d2p1:ReportDateLocal>
    <d2p1:ReportHeaderFormat>sample string 4</d2p1:ReportHeaderFormat>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:StartYear>5</d2p1:StartYear>
    <d2p1:YearCount>6</d2p1:YearCount>
  </Model>
  <ResponseCode>Success</ResponseCode>
</ReportingModelResponse>