POST api/Reconciliation/CustomReportTemplateList

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ReconciliationReportTemplateID	integer	None.
TemplateName	string	None.
ReportTypeID	integer	None.
CombineResultsToSingleFile	boolean	None.
ReconciliationGroupID	string	None.
StatementEntityIDs	Collection of integer	None.
IncludeBalances	boolean	None.
IncludePayerDetails	boolean	None.
ShowReceiptUnverified	boolean	None.
TimezoneName	string	None.
FileNameFormat	string	None.
ShowCurrentSettlementAmounts	boolean	None.
ShowChargeValueIncGSTCol	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ReconciliationReportTemplateID": 1,
  "TemplateName": "sample string 2",
  "ReportTypeID": 3,
  "CombineResultsToSingleFile": true,
  "ReconciliationGroupID": "sample string 5",
  "StatementEntityIDs": [
    1,
    2
  ],
  "IncludeBalances": true,
  "IncludePayerDetails": true,
  "ShowReceiptUnverified": true,
  "TimezoneName": "sample string 9",
  "FileNameFormat": "sample string 10",
  "ShowCurrentSettlementAmounts": true,
  "ShowChargeValueIncGSTCol": true
}

application/xml, text/xml

Sample:

<CustomReportTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Reconciliation">
  <CombineResultsToSingleFile>true</CombineResultsToSingleFile>
  <FileNameFormat>sample string 10</FileNameFormat>
  <IncludeBalances>true</IncludeBalances>
  <IncludePayerDetails>true</IncludePayerDetails>
  <ReconciliationGroupID>sample string 5</ReconciliationGroupID>
  <ReconciliationReportTemplateID>1</ReconciliationReportTemplateID>
  <ReportTypeID>3</ReportTypeID>
  <ShowChargeValueIncGSTCol>true</ShowChargeValueIncGSTCol>
  <ShowCurrentSettlementAmounts>true</ShowCurrentSettlementAmounts>
  <ShowReceiptUnverified>true</ShowReceiptUnverified>
  <StatementEntityIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </StatementEntityIDs>
  <TemplateName>sample string 2</TemplateName>
  <TimezoneName>sample string 9</TimezoneName>
</CustomReportTemplate>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CustomReportTemplate'.

Response Information

Resource Description

CommonResult

Name	Description	Type	Additional information
ErrorMessage		string	None.
Result		Object	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 1",
  "Result": {}
}

application/xml, text/xml

Sample:

<CommonResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ConsoleAPI.Internal.Models.Common">
  <ErrorMessage>sample string 1</ErrorMessage>
  <Result />
</CommonResult>