POST api/Commissions/GetCommissionsReportDataForDownload
Export statement list as pdf
Request Information
URI Parameters
None.
Body Parameters
filter param
CommissionInputName | Description | Type | Additional information |
---|---|---|---|
StakeHolder |
Agent Id int array |
Collection of string |
None. |
Currency |
Currency |
string |
None. |
Agent | string |
None. |
|
Agency | string |
None. |
|
Number |
commission number |
string |
None. |
StatementFromDate | date |
None. |
|
StatementToDate | date |
None. |
|
PostFromDate | date |
None. |
|
PostToDate | date |
None. |
|
DoNotPay | string |
None. |
|
Status | string |
None. |
|
NotificationStatus | string |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
SortOption | integer |
None. |
|
PolicyNumber | string |
None. |
|
PolicyHolderName | string |
None. |
|
Product | string |
None. |
|
Category | string |
None. |
|
Type | string |
None. |
|
CommissionStatementId | integer |
None. |
|
StatementDate | string |
None. |
|
AgentCode | string |
None. |
|
TemplateId | integer |
None. |
|
StatementId | integer |
None. |
|
IsSummaryTemplate | boolean |
None. |
|
CommissionWeekLastOrThis | integer |
None. |
|
CommissionFromDate | date |
None. |
|
CommissionToDate | date |
None. |
Request Formats
application/json, text/json
Sample:
{ "StakeHolder": [ "sample string 1", "sample string 2" ], "Currency": "sample string 1", "Agent": "sample string 2", "Agency": "sample string 3", "Number": "sample string 4", "StatementFromDate": "2024-03-28T05:43:50.6254574-07:00", "StatementToDate": "2024-03-28T05:43:50.6254574-07:00", "PostFromDate": "2024-03-28T05:43:50.6254574-07:00", "PostToDate": "2024-03-28T05:43:50.6254574-07:00", "DoNotPay": "sample string 5", "Status": "sample string 6", "NotificationStatus": "sample string 7", "PageNumber": 8, "PageSize": 9, "SortOption": 10, "PolicyNumber": "sample string 11", "PolicyHolderName": "sample string 12", "Product": "sample string 13", "Category": "sample string 14", "Type": "sample string 15", "CommissionStatementId": 16, "StatementDate": "sample string 17", "AgentCode": "sample string 18", "TemplateId": 1, "StatementId": 1, "IsSummaryTemplate": true, "CommissionWeekLastOrThis": 1, "CommissionFromDate": "2024-03-28T05:43:50.6254574-07:00", "CommissionToDate": "2024-03-28T05:43:50.6254574-07:00" }
application/xml, text/xml
Sample:
<CommissionInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.AS.AgentPortal.API.Areas.Commission.Models"> <Agency>sample string 3</Agency> <Agent>sample string 2</Agent> <AgentCode>sample string 18</AgentCode> <Category>sample string 14</Category> <CommissionFromDate>2024-03-28T05:43:50.6254574-07:00</CommissionFromDate> <CommissionStatementId>16</CommissionStatementId> <CommissionToDate>2024-03-28T05:43:50.6254574-07:00</CommissionToDate> <CommissionWeekLastOrThis>1</CommissionWeekLastOrThis> <Currency>sample string 1</Currency> <DoNotPay>sample string 5</DoNotPay> <IsSummaryTemplate>true</IsSummaryTemplate> <NotificationStatus>sample string 7</NotificationStatus> <Number>sample string 4</Number> <PageNumber>8</PageNumber> <PageSize>9</PageSize> <PolicyHolderName>sample string 12</PolicyHolderName> <PolicyNumber>sample string 11</PolicyNumber> <PostFromDate>2024-03-28T05:43:50.6254574-07:00</PostFromDate> <PostToDate>2024-03-28T05:43:50.6254574-07:00</PostToDate> <Product>sample string 13</Product> <SortOption>10</SortOption> <StakeHolder xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </StakeHolder> <StatementDate>sample string 17</StatementDate> <StatementFromDate>2024-03-28T05:43:50.6254574-07:00</StatementFromDate> <StatementId>1</StatementId> <StatementToDate>2024-03-28T05:43:50.6254574-07:00</StatementToDate> <Status>sample string 6</Status> <TemplateId>1</TemplateId> <Type>sample string 15</Type> </CommissionInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |