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

Request Information

URI Parameters

Name	Description	Type	Additional information
uniqueClientID		integer	Required

Body Parameters

EYCTCWebIHCoSchFrSrcIncIncomeItem

Name	Type	Additional information
FrSrcSchID	integer	None.
IncomeID	integer	None.
ItemID	integer	None.
CountryCode	integer	None.
CountryName	string	None.
CountryKV	Pair of string [key] and integer [value]	None.
CurrencyCode	integer	None.
CurrencyKV	Pair of string [key] and integer [value]	None.
YA	integer	None.
HistoricalGrossIncomeAmount	decimal number	None.
HistoricalGrossIncomeAmounts	Collection of decimal number	None.
GrossIncomeAmount	decimal number	None.
GrossIncomeAmounts	Collection of decimal number	None.
WithholdingTaxSufferedAmount	decimal number	None.
WithholdingTaxSufferedAmounts	Collection of decimal number	None.
UnderlyingTaxSufferedAmount	decimal number	None.
UnderlyingTaxSufferedAmounts	Collection of decimal number	None.
UnderlyingTaxSufferedPercentage	decimal number	None.
RegrossIncomeAmount	decimal number	None.
RegrossIncomeAmounts	Collection of decimal number	None.
ExpenseAmount	decimal number	None.
Description	string	None.
IsDividendIncome	boolean	None.
IsUnderlyingIncomeTaxes	boolean	None.
IsUnderlyingTaxSufferedPercentage	boolean	None.
IncomeTypeKV	Pair of integer [key] and string [value]	None.
IncomeType	integer	None.
IsWithholdingTaxFull	boolean	None.
FTCClaim	integer	None.
FTCClaimKV	Pair of integer [key] and string [value]	None.
Tag	string	None.
UsageOfFunds	Collection of EYCTCWebIHCoSchFrSrcIncUsageItem	None.
ExpenseItem	Collection of EYCTCWebIHCoSchFrSrcIncExpenseItem	None.

Request Formats

application/json, text/json

Sample:

{
  "FrSrcSchID": 1,
  "IncomeID": 2,
  "ItemID": 3,
  "CountryCode": 4,
  "CountryName": "sample string 5",
  "CountryKV": {
    "Key": "sample string 1",
    "Value": 2
  },
  "CurrencyCode": 6,
  "CurrencyKV": {
    "Key": "sample string 1",
    "Value": 2
  },
  "YA": 7,
  "HistoricalGrossIncomeAmount": 3.0,
  "HistoricalGrossIncomeAmounts": [
    1.0,
    2.0
  ],
  "GrossIncomeAmount": 3.0,
  "GrossIncomeAmounts": [
    1.0,
    2.0
  ],
  "WithholdingTaxSufferedAmount": 3.0,
  "WithholdingTaxSufferedAmounts": [
    1.0,
    2.0
  ],
  "UnderlyingTaxSufferedAmount": 3.0,
  "UnderlyingTaxSufferedAmounts": [
    1.0,
    2.0
  ],
  "UnderlyingTaxSufferedPercentage": 8.0,
  "RegrossIncomeAmount": 3.0,
  "RegrossIncomeAmounts": [
    1.0,
    2.0
  ],
  "ExpenseAmount": 9.0,
  "Description": "sample string 10",
  "IsDividendIncome": true,
  "IsUnderlyingIncomeTaxes": true,
  "IsUnderlyingTaxSufferedPercentage": true,
  "IncomeTypeKV": {
    "Key": 1,
    "Value": "sample string 2"
  },
  "IncomeType": 14,
  "IsWithholdingTaxFull": true,
  "FTCClaim": 16,
  "FTCClaimKV": {
    "Key": 1,
    "Value": "sample string 2"
  },
  "Tag": "sample string 17",
  "UsageOfFunds": [
    {
      "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
    },
    {
      "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
    }
  ],
  "ExpenseItem": [
    {
      "FrSrcSchID": 1,
      "IncomeID": 2,
      "OtherExpID": 3,
      "ItemID": 4,
      "Description": "sample string 5",
      "ExpType": "sample string 6",
      "Amount": 3.0,
      "Amounts": [
        1.0,
        2.0
      ]
    },
    {
      "FrSrcSchID": 1,
      "IncomeID": 2,
      "OtherExpID": 3,
      "ItemID": 4,
      "Description": "sample string 5",
      "ExpType": "sample string 6",
      "Amount": 3.0,
      "Amounts": [
        1.0,
        2.0
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<EYCTCWebIHCoSchFrSrcIncIncomeItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EYCAPL.CTS.Web">
  <CountryCode>4</CountryCode>
  <CountryKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>sample string 1</d2p1:key>
    <d2p1:value>2</d2p1:value>
  </CountryKV>
  <CountryName>sample string 5</CountryName>
  <CurrencyCode>6</CurrencyCode>
  <CurrencyKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>sample string 1</d2p1:key>
    <d2p1:value>2</d2p1:value>
  </CurrencyKV>
  <Description>sample string 10</Description>
  <ExpenseAmount>9</ExpenseAmount>
  <ExpenseItem>
    <EYCTCWebIHCoSchFrSrcIncExpenseItem>
      <Amounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </Amounts>
      <Description>sample string 5</Description>
      <ExpType>sample string 6</ExpType>
      <FrSrcSchID>1</FrSrcSchID>
      <IncomeID>2</IncomeID>
      <ItemID>4</ItemID>
      <OtherExpID>3</OtherExpID>
    </EYCTCWebIHCoSchFrSrcIncExpenseItem>
    <EYCTCWebIHCoSchFrSrcIncExpenseItem>
      <Amounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </Amounts>
      <Description>sample string 5</Description>
      <ExpType>sample string 6</ExpType>
      <FrSrcSchID>1</FrSrcSchID>
      <IncomeID>2</IncomeID>
      <ItemID>4</ItemID>
      <OtherExpID>3</OtherExpID>
    </EYCTCWebIHCoSchFrSrcIncExpenseItem>
  </ExpenseItem>
  <FTCClaim>16</FTCClaim>
  <FTCClaimKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>1</d2p1:key>
    <d2p1:value>sample string 2</d2p1:value>
  </FTCClaimKV>
  <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>
  <HistoricalGrossIncomeAmounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </HistoricalGrossIncomeAmounts>
  <IncomeID>2</IncomeID>
  <IncomeType>14</IncomeType>
  <IncomeTypeKV xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>1</d2p1:key>
    <d2p1:value>sample string 2</d2p1:value>
  </IncomeTypeKV>
  <IsDividendIncome>true</IsDividendIncome>
  <IsUnderlyingIncomeTaxes>true</IsUnderlyingIncomeTaxes>
  <IsUnderlyingTaxSufferedPercentage>true</IsUnderlyingTaxSufferedPercentage>
  <IsWithholdingTaxFull>true</IsWithholdingTaxFull>
  <ItemID>3</ItemID>
  <RegrossIncomeAmounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </RegrossIncomeAmounts>
  <Tag>sample string 17</Tag>
  <UnderlyingTaxSufferedAmounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </UnderlyingTaxSufferedAmounts>
  <UnderlyingTaxSufferedPercentage>8</UnderlyingTaxSufferedPercentage>
  <UsageOfFunds>
    <EYCTCWebIHCoSchFrSrcIncUsageItem>
      <DTRClaim>11</DTRClaim>
      <DTRClaimKV xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </DTRClaimKV>
      <ExpenseAmount>17</ExpenseAmount>
      <FrSrcSchID>1</FrSrcSchID>
      <GrossIncomeAmounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </UsageOfFundKV>
      <WithholdingTaxSufferedAmount>15</WithholdingTaxSufferedAmount>
      <WithholdingTaxSufferedAmountsOverwrite xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </WithholdingTaxSufferedAmountsOverwrite>
    </EYCTCWebIHCoSchFrSrcIncUsageItem>
    <EYCTCWebIHCoSchFrSrcIncUsageItem>
      <DTRClaim>11</DTRClaim>
      <DTRClaimKV xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </DTRClaimKV>
      <ExpenseAmount>17</ExpenseAmount>
      <FrSrcSchID>1</FrSrcSchID>
      <GrossIncomeAmounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
        <d4p1:key>1</d4p1:key>
        <d4p1:value>sample string 2</d4p1:value>
      </UsageOfFundKV>
      <WithholdingTaxSufferedAmount>15</WithholdingTaxSufferedAmount>
      <WithholdingTaxSufferedAmountsOverwrite xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:decimal>1</d4p1:decimal>
        <d4p1:decimal>2</d4p1:decimal>
      </WithholdingTaxSufferedAmountsOverwrite>
    </EYCTCWebIHCoSchFrSrcIncUsageItem>
  </UsageOfFunds>
  <WithholdingTaxSufferedAmounts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:decimal>1</d2p1:decimal>
    <d2p1:decimal>2</d2p1:decimal>
  </WithholdingTaxSufferedAmounts>
  <YA>7</YA>
</EYCTCWebIHCoSchFrSrcIncIncomeItem>

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.