GET api/OmsReporting/financials/transactions-by-month/model?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional Information
siteId		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

MonthlySalesRecapModelResponse

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

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "YearRequested": 1,
    "PossibleYears": [
      1,
      2
    ],
    "Sites": null,
    "CurrentSiteId": 2,
    "RecapData": [
      {
        "Month": 1,
        "Year": 2,
        "Sales": 3.0,
        "Discount": 4.0,
        "Tax": 5.0,
        "Shipping": 6.0,
        "Total": 7.0,
        "Growth": 8.0,
        "FormattedSales": "sample string 9",
        "FormattedDiscount": "sample string 10",
        "FormattedTax": "sample string 11",
        "FormattedShipping": "sample string 12",
        "FormattedTotal": "sample string 13",
        "FormattedGrowth": "sample string 14",
        "MonthName": "sample string 15"
      },
      {
        "Month": 1,
        "Year": 2,
        "Sales": 3.0,
        "Discount": 4.0,
        "Tax": 5.0,
        "Shipping": 6.0,
        "Total": 7.0,
        "Growth": 8.0,
        "FormattedSales": "sample string 9",
        "FormattedDiscount": "sample string 10",
        "FormattedTax": "sample string 11",
        "FormattedShipping": "sample string 12",
        "FormattedTotal": "sample string 13",
        "FormattedGrowth": "sample string 14",
        "MonthName": "sample string 15"
      }
    ],
    "CurrentSite": null,
    "EnableExport": true
  }
}

application/xml, text/xml

Sample:

<MonthlySalesRecapModelResponse 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:CurrentSite i:nil="true" />
    <d2p1:CurrentSiteId>2</d2p1:CurrentSiteId>
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:PossibleYears xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:PossibleYears>
    <d2p1:RecapData>
      <d2p1:MonthlySalesRecap>
        <d2p1:Discount>4</d2p1:Discount>
        <d2p1:FormattedDiscount>sample string 10</d2p1:FormattedDiscount>
        <d2p1:FormattedGrowth>sample string 14</d2p1:FormattedGrowth>
        <d2p1:FormattedSales>sample string 9</d2p1:FormattedSales>
        <d2p1:FormattedShipping>sample string 12</d2p1:FormattedShipping>
        <d2p1:FormattedTax>sample string 11</d2p1:FormattedTax>
        <d2p1:FormattedTotal>sample string 13</d2p1:FormattedTotal>
        <d2p1:Growth>8</d2p1:Growth>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:MonthName>sample string 15</d2p1:MonthName>
        <d2p1:Sales>3</d2p1:Sales>
        <d2p1:Shipping>6</d2p1:Shipping>
        <d2p1:Tax>5</d2p1:Tax>
        <d2p1:Total>7</d2p1:Total>
        <d2p1:Year>2</d2p1:Year>
      </d2p1:MonthlySalesRecap>
      <d2p1:MonthlySalesRecap>
        <d2p1:Discount>4</d2p1:Discount>
        <d2p1:FormattedDiscount>sample string 10</d2p1:FormattedDiscount>
        <d2p1:FormattedGrowth>sample string 14</d2p1:FormattedGrowth>
        <d2p1:FormattedSales>sample string 9</d2p1:FormattedSales>
        <d2p1:FormattedShipping>sample string 12</d2p1:FormattedShipping>
        <d2p1:FormattedTax>sample string 11</d2p1:FormattedTax>
        <d2p1:FormattedTotal>sample string 13</d2p1:FormattedTotal>
        <d2p1:Growth>8</d2p1:Growth>
        <d2p1:Month>1</d2p1:Month>
        <d2p1:MonthName>sample string 15</d2p1:MonthName>
        <d2p1:Sales>3</d2p1:Sales>
        <d2p1:Shipping>6</d2p1:Shipping>
        <d2p1:Tax>5</d2p1:Tax>
        <d2p1:Total>7</d2p1:Total>
        <d2p1:Year>2</d2p1:Year>
      </d2p1:MonthlySalesRecap>
    </d2p1:RecapData>
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:YearRequested>1</d2p1:YearRequested>
  </Model>
  <ResponseCode>Success</ResponseCode>
</MonthlySalesRecapModelResponse>