POST api/FSI/AddUsageItem?uniqueClientID={uniqueClientID}

Request Information

URI Parameters

Name	Description	Type	Additional information
uniqueClientID		integer	Required

Body Parameters

EYCTCWebIHCoSchFrSrcIncUsageItem

Name	Type	Additional information
FrSrcSchID	integer	None.
IncomeID	integer	None.
UsageID	integer	None.
ItemID	integer	None.
UsageOfFund	integer	None.
UsageOfFundKV	Pair of integer [key] and string [value]	None.
InvestmentName	string	None.
IsNotSubjectedToTax	boolean	None.
NotSubjectedToTaxReason	string	None.
GrossIncomeAmount	decimal number	None.
GrossIncomeAmounts	Collection of decimal number	None.
UnderlyingTaxSufferedAmount	decimal number	None.
RegrossIncomeAmount	decimal number	None.
DTRClaim	integer	None.
DTRClaimKV	Pair of integer [key] and string [value]	None.
IsFTCPooling	boolean	None.
IsUnderlyingTax	boolean	None.
WithholdingTaxSufferedAmountOverwrite	decimal number	None.
WithholdingTaxSufferedAmountsOverwrite	Collection of decimal number	None.
IsWithholdingTaxSufferedOverwrite	boolean	None.
WithholdingTaxSufferedAmount	decimal number	None.
HistoricalGrossIncomeAmount	decimal number	None.
ExpenseAmount	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "FrSrcSchID": 1,
  "IncomeID": 2,
  "UsageID": 3,
  "ItemID": 4,
  "UsageOfFund": 5,
  "UsageOfFundKV": {
    "Key": 1,
    "Value": "sample string 2"
  },
  "InvestmentName": "sample string 6",
  "IsNotSubjectedToTax": true,
  "NotSubjectedToTaxReason": "sample string 8",
  "GrossIncomeAmount": 3.0,
  "GrossIncomeAmounts": [
    1.0,
    2.0
  ],
  "UnderlyingTaxSufferedAmount": 9.0,
  "RegrossIncomeAmount": 10.0,
  "DTRClaim": 11,
  "DTRClaimKV": {
    "Key": 1,
    "Value": "sample string 2"
  },
  "IsFTCPooling": true,
  "IsUnderlyingTax": true,
  "WithholdingTaxSufferedAmountOverwrite": 3.0,
  "WithholdingTaxSufferedAmountsOverwrite": [
    1.0,
    2.0
  ],
  "IsWithholdingTaxSufferedOverwrite": true,
  "WithholdingTaxSufferedAmount": 15.0,
  "HistoricalGrossIncomeAmount": 16.0,
  "ExpenseAmount": 17.0
}

application/xml, text/xml

Sample:

<EYCTCWebIHCoSchFrSrcIncUsageItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EYCAPL.CTS.Web">
  <DTRClaim>11</DTRClaim>
  <DTRClaimKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>1</d2p1:key>
    <d2p1:value>sample string 2</d2p1:value>
  </DTRClaimKV>
  <ExpenseAmount>17</ExpenseAmount>
  <FrSrcSchID>1</FrSrcSchID>
  <GrossIncomeAmounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </GrossIncomeAmounts>
  <HistoricalGrossIncomeAmount>16</HistoricalGrossIncomeAmount>
  <IncomeID>2</IncomeID>
  <InvestmentName>sample string 6</InvestmentName>
  <IsFTCPooling>true</IsFTCPooling>
  <IsNotSubjectedToTax>true</IsNotSubjectedToTax>
  <IsUnderlyingTax>true</IsUnderlyingTax>
  <IsWithholdingTaxSufferedOverwrite>true</IsWithholdingTaxSufferedOverwrite>
  <ItemID>4</ItemID>
  <NotSubjectedToTaxReason>sample string 8</NotSubjectedToTaxReason>
  <RegrossIncomeAmount>10</RegrossIncomeAmount>
  <UnderlyingTaxSufferedAmount>9</UnderlyingTaxSufferedAmount>
  <UsageID>3</UsageID>
  <UsageOfFund>5</UsageOfFund>
  <UsageOfFundKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>1</d2p1:key>
    <d2p1:value>sample string 2</d2p1:value>
  </UsageOfFundKV>
  <WithholdingTaxSufferedAmount>15</WithholdingTaxSufferedAmount>
  <WithholdingTaxSufferedAmountsOverwrite xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </WithholdingTaxSufferedAmountsOverwrite>
</EYCTCWebIHCoSchFrSrcIncUsageItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	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.