POST RoyaltyReport/GenerateReportGC

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.Common.RoyaltyReport.ReportViewModel
NameDescriptionTypeAdditional information
SelectedReportType

integer

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: 
{
  "SelectedReportType": 1,
  "SelectedCompanies": [
    1,
    2
  ],
  "OrderSource": 1,
  "Start": "2025-04-03T22:22:48.1490125-04:00",
  "End": "2025-04-03T22:22:48.1490125-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":22,\"seconds\":48,\"miliseconds\":149}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":22,\"seconds\":48,\"miliseconds\":149}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of IConnect.Domain.Reports.Common.RoyaltyReport.RoyaltyGCReportItem
NameDescriptionTypeAdditional information
LocationId

integer

None.
Location

string

None.
Sold

decimal number

None.
Redeemed

decimal number

None.
Outstanding

decimal number

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "LocationId": 1,
    "Location": "sample string 2",
    "Sold": 3.0,
    "Redeemed": 4.0,
    "Outstanding": -1.0
  },
  {
    "LocationId": 1,
    "Location": "sample string 2",
    "Sold": 3.0,
    "Redeemed": 4.0,
    "Outstanding": -1.0
  }
]

application/xml, text/xml

Sample: 
<ArrayOfRoyaltyGCReportItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.Common.RoyaltyReport">
  <RoyaltyGCReportItem>
    <Location>sample string 2</Location>
    <LocationId>1</LocationId>
    <Redeemed>4</Redeemed>
    <Sold>3</Sold>
  </RoyaltyGCReportItem>
  <RoyaltyGCReportItem>
    <Location>sample string 2</Location>
    <LocationId>1</LocationId>
    <Redeemed>4</Redeemed>
    <Sold>3</Sold>
  </RoyaltyGCReportItem>
</ArrayOfRoyaltyGCReportItem>