POST RoyaltyReport/GenerateDetailsByRoyaltyProgramReport

Request Information

URI Parameters

None.

Body Parameters

IConnect.Domain.Reports.Common.RoyaltyReport.DetailedReportViewModel
NameDescriptionTypeAdditional information
CompanyId

integer

None.
RoyaltyReportId

integer

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: 
{
  "CompanyId": 1,
  "RoyaltyReportId": 2,
  "Start": "2025-04-03T22:25:29.0301984-04:00",
  "End": "2025-04-03T22:25:29.0301984-04:00",
  "StartDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":25,\"seconds\":29,\"miliseconds\":30}",
  "EndDateObjectString": "{\"year\":2025,\"month\":4,\"date\":3,\"hours\":22,\"minutes\":25,\"seconds\":29,\"miliseconds\":30}",
  "SkipTimeZoneConvertion": true,
  "ForceImmediateExport": true
}

application/xml, text/xml

Sample: 
<DetailedReportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports.Common.RoyaltyReport">
  <_x003C_End_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:25:29.0301984-04:00</_x003C_End_x003E_k__BackingField>
  <_x003C_ForceImmediateExport_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_ForceImmediateExport_x003E_k__BackingField>
  <_x003C_SkipTimeZoneConvertion_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">true</_x003C_SkipTimeZoneConvertion_x003E_k__BackingField>
  <_x003C_Start_x003E_k__BackingField xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Reports">2025-04-03T22:25:29.0301984-04:00</_x003C_Start_x003E_k__BackingField>
  <_x003C_CompanyId_x003E_k__BackingField>1</_x003C_CompanyId_x003E_k__BackingField>
  <_x003C_RoyaltyReportId_x003E_k__BackingField>2</_x003C_RoyaltyReportId_x003E_k__BackingField>
</DetailedReportViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IConnect.ReportingApi.Core.ApiFileResponse
NameDescriptionTypeAdditional information
StatusCode

IConnect.ReportingApi.Core.ApiStatusCode

None.
Message

string

None.
Data

string

None.
IsSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:

Sample not available.