POST api/SaveWithHoldingInfo

Request Information

URI Parameters

None.

Body Parameters

WithHoldingInformationModel
Name Description Type Additional information
Id

integer

None.

DATE_OF_ALLOCATION

date

None.

ALLOCATION_END_DATE

date

None.

CLIENT_ID

integer

None.

INVESTOR_ID

integer

None.

strINVESTOR_ID

string

None.

RECIPIENT_ID

integer

None.

strRECIPIENT_ID

string

None.

RECIPIENT_STATUS

string

None.

RECIPIENT_TYPE

string

None.

INTERMIDIARY_INVESTOR_ID

integer

None.

INTERMIDIARY_BO_ID

integer

None.

INTERMIDIARY_INVESTOR_BO_ID

integer

None.

INTERMIDIARY_INVESTOR

string

None.

INTERMIDIARY_ALLOCATION

decimal number

None.

INTEREST_TYPE

string

None.

WITHHOLDING_RATE_INTEREST

string

None.

WITH_HOLDING_INTEREST

decimal number

None.

DIVIDEND_TYPE

string

None.

WITHHOLDING_RATE_DIVIDENDS

string

None.

WITH_HOLDING_DIVIDEND

decimal number

None.

OTHER_INCOME_TYPE

string

None.

WITHHOLDING_RATE_OTHER

string

None.

WITH_HOLDING_OTHER

decimal number

None.

RECIPIENT_NAME

string

None.

strDATE_OF_ALLOCATION

string

None.

strALLOCATION_END_DATE

string

None.

INVESTOR_INTER_ID

integer

None.

INVESTOR_GIIN

string

None.

INVESTOR_ADDRESS_NUMBER_STREET

string

None.

INVESTOR_ADDRESS_LINE_TWO

string

None.

INVESTOR_ADDRESS_CITY

string

None.

INVESTOR_ADDRESS_STATE

string

None.

INVESTOR_ADDRESS_POST_CODE

string

None.

INVESTOR_ADDRESS_COUNTRY_ID

integer

None.

INVESTOR_ADDRESS_COUNTRY_NAME

string

None.

INVESTOR_FULL_ADDRESS

string

None.

PAYEE_ALLOCATION

decimal number

None.

strNET_WITH_HOLDING_INTEREST

string

None.

strNET_WITH_HOLDING_DIVIDEND

string

None.

strNET_WITH_HOLDING_OTHER

string

None.

strPAYEE_ALLOCATION

string

None.

strWITH_HOLDING_INTEREST

string

None.

strWITH_HOLDING_DIVIDEND

string

None.

strWITH_HOLDING_OTHER

string

None.

strINTERMIDIARY_ALLOCATION

string

None.

strBENEFICIAL_OWNER_ID

string

None.

RECORD_ID

integer

None.

strRECORD_ID

string

None.

TAX_RECIDENCY_1

string

None.

US_TAX_CLASSIFICATION_NAME

string

None.

LOCAL_TAX_STATUS

string

None.

CLIENT_REFERENCE_ID

string

None.

ADDRESS_NUMBER_STREET

string

None.

ADDRESS_LINE_TWO

string

None.

ADDRESS_CITY

string

None.

ADDRESS_STATE

string

None.

ADDRESS_POST_CODE

string

None.

ADDRESS_COUNTRY_ID

integer

None.

ADDRESS_COUNTRY_NAME

string

None.

FULL_ADDRESS

string

None.

TIN_1

string

None.

EIN

string

None.

TREATY_COUNTRY_ID

integer

None.

TREATY_COUNTRY_Name

string

None.

CHAPTER_3_STATUS_CODE

string

None.

CHAPTER_4_STATUS_CODE

string

None.

INTEREST_TYPE_BO

string

None.

INTEREST_CH3_BASIS_EXEMPTION

string

None.

INTEREST_CH3_BASIS_EXEMPTION_BO

string

None.

DIVIDEND_TYPE_BO

string

None.

DIVIDEND_CH3_BASIS_EXEMPTION

string

None.

DIVIDEND_CH3_BASIS_EXEMPTION_BO

string

None.

OTHER_INCOME_TYPE_BO

string

None.

OTHER_INCOME_CH3_BASIS_EXEMPTION

string

None.

OTHER_INCOME_CH3_BASIS_EXEMPTION_BO

string

None.

LOB_CODE

string

None.

LOB_CODE_BO

string

None.

FORM_TYPE_NAME

string

None.

ChildCount

integer

None.

US_TAX_CLASSIFICATION_ID

integer

None.

LOCAL_TAX_CLASSIFICATION_ID

integer

None.

StrCREATED_ON

string

None.

LOCAL_TAX_STATUS_NAME

string

None.

GIIN

string

None.

EBOR_RECORD_ID

integer

None.

EBOR_ENTITY_ID

integer

None.

EBOR_BENEFICIAL_OWNER_ID

integer

None.

EBOR_CLIENT_ID

integer

None.

EBOR_RECORD_START_DT

date

None.

strCreatedOn

string

None.

EBOR_RECORD_END_DT

date

None.

GE_RECORD_ID

integer

None.

strGE_RECORD_ID

string

None.

GE_ENTITY_ID

integer

None.

strGE_ENTITY_ID

string

None.

GE_CLIENT_ID

integer

None.

GE_CLIENT_REFERENCE_NAME

string

None.

GE_LEGAL_ENTITY_NAME

string

None.

GE_GROUP_ENTITY_FULL_NAME

string

None.

strWithHoldingDateOfAllocationID

string

None.

WithHoldingDateOfAllocationID

integer

None.

strWithHoldingDateOfAllocation

string

None.

SelectedWithHoldingDateOfAllocation

string

None.

UnSelectedWithHoldingDateOfAllocation

string

None.

WithholdingName

string

None.

StrINTERMIDIARY_INVESTOR

string

None.

EndAlocationEntityIds

string

None.

WithHoldingParameterModel

WithHoldingParameterModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "DATE_OF_ALLOCATION": "2025-06-23T13:12:12.6188911+00:00",
  "ALLOCATION_END_DATE": "2025-06-23T13:12:12.6188911+00:00",
  "CLIENT_ID": 1,
  "INVESTOR_ID": 1,
  "strINVESTOR_ID": "sample string 1",
  "RECIPIENT_ID": 1,
  "strRECIPIENT_ID": "sample string 2",
  "RECIPIENT_STATUS": "sample string 3",
  "RECIPIENT_TYPE": "sample string 4",
  "INTERMIDIARY_INVESTOR_ID": 1,
  "INTERMIDIARY_BO_ID": 1,
  "INTERMIDIARY_INVESTOR_BO_ID": 1,
  "INTERMIDIARY_INVESTOR": "sample string 5",
  "INTERMIDIARY_ALLOCATION": 1.0,
  "INTEREST_TYPE": "sample string 6",
  "WITHHOLDING_RATE_INTEREST": "sample string 7",
  "WITH_HOLDING_INTEREST": 1.0,
  "DIVIDEND_TYPE": "sample string 8",
  "WITHHOLDING_RATE_DIVIDENDS": "sample string 9",
  "WITH_HOLDING_DIVIDEND": 1.0,
  "OTHER_INCOME_TYPE": "sample string 10",
  "WITHHOLDING_RATE_OTHER": "sample string 11",
  "WITH_HOLDING_OTHER": 1.0,
  "RECIPIENT_NAME": "sample string 12",
  "strDATE_OF_ALLOCATION": "sample string 13",
  "strALLOCATION_END_DATE": "sample string 14",
  "INVESTOR_INTER_ID": 1,
  "INVESTOR_GIIN": "sample string 15",
  "INVESTOR_ADDRESS_NUMBER_STREET": "sample string 16",
  "INVESTOR_ADDRESS_LINE_TWO": "sample string 17",
  "INVESTOR_ADDRESS_CITY": "sample string 18",
  "INVESTOR_ADDRESS_STATE": "sample string 19",
  "INVESTOR_ADDRESS_POST_CODE": "sample string 20",
  "INVESTOR_ADDRESS_COUNTRY_ID": 1,
  "INVESTOR_ADDRESS_COUNTRY_NAME": "sample string 21",
  "INVESTOR_FULL_ADDRESS": "sample string 22",
  "PAYEE_ALLOCATION": 1.0,
  "strNET_WITH_HOLDING_INTEREST": "sample string 23",
  "strNET_WITH_HOLDING_DIVIDEND": "sample string 24",
  "strNET_WITH_HOLDING_OTHER": "sample string 25",
  "strPAYEE_ALLOCATION": "sample string 26",
  "strWITH_HOLDING_INTEREST": "sample string 27",
  "strWITH_HOLDING_DIVIDEND": "sample string 28",
  "strWITH_HOLDING_OTHER": "sample string 29",
  "strINTERMIDIARY_ALLOCATION": "sample string 30",
  "strBENEFICIAL_OWNER_ID": "sample string 31",
  "RECORD_ID": 32,
  "strRECORD_ID": "sample string 33",
  "TAX_RECIDENCY_1": "sample string 34",
  "US_TAX_CLASSIFICATION_NAME": "sample string 35",
  "LOCAL_TAX_STATUS": "sample string 36",
  "CLIENT_REFERENCE_ID": "sample string 37",
  "ADDRESS_NUMBER_STREET": "sample string 38",
  "ADDRESS_LINE_TWO": "sample string 39",
  "ADDRESS_CITY": "sample string 40",
  "ADDRESS_STATE": "sample string 41",
  "ADDRESS_POST_CODE": "sample string 42",
  "ADDRESS_COUNTRY_ID": 1,
  "ADDRESS_COUNTRY_NAME": "sample string 43",
  "FULL_ADDRESS": "sample string 44",
  "TIN_1": "sample string 45",
  "EIN": "sample string 46",
  "TREATY_COUNTRY_ID": 1,
  "TREATY_COUNTRY_Name": "sample string 47",
  "CHAPTER_3_STATUS_CODE": "sample string 48",
  "CHAPTER_4_STATUS_CODE": "sample string 49",
  "INTEREST_TYPE_BO": "sample string 50",
  "INTEREST_CH3_BASIS_EXEMPTION": "sample string 51",
  "INTEREST_CH3_BASIS_EXEMPTION_BO": "sample string 52",
  "DIVIDEND_TYPE_BO": "sample string 53",
  "DIVIDEND_CH3_BASIS_EXEMPTION": "sample string 54",
  "DIVIDEND_CH3_BASIS_EXEMPTION_BO": "sample string 55",
  "OTHER_INCOME_TYPE_BO": "sample string 56",
  "OTHER_INCOME_CH3_BASIS_EXEMPTION": "sample string 57",
  "OTHER_INCOME_CH3_BASIS_EXEMPTION_BO": "sample string 58",
  "LOB_CODE": "sample string 59",
  "LOB_CODE_BO": "sample string 60",
  "FORM_TYPE_NAME": "sample string 61",
  "ChildCount": 1,
  "US_TAX_CLASSIFICATION_ID": 1,
  "LOCAL_TAX_CLASSIFICATION_ID": 1,
  "StrCREATED_ON": "sample string 62",
  "LOCAL_TAX_STATUS_NAME": "sample string 63",
  "GIIN": "sample string 64",
  "EBOR_RECORD_ID": 1,
  "EBOR_ENTITY_ID": 1,
  "EBOR_BENEFICIAL_OWNER_ID": 1,
  "EBOR_CLIENT_ID": 1,
  "EBOR_RECORD_START_DT": "2025-06-23T13:12:12.6188911+00:00",
  "strCreatedOn": "sample string 65",
  "EBOR_RECORD_END_DT": "2025-06-23T13:12:12.6188911+00:00",
  "GE_RECORD_ID": 1,
  "strGE_RECORD_ID": "sample string 66",
  "GE_ENTITY_ID": 1,
  "strGE_ENTITY_ID": "sample string 67",
  "GE_CLIENT_ID": 1,
  "GE_CLIENT_REFERENCE_NAME": "sample string 68",
  "GE_LEGAL_ENTITY_NAME": "sample string 69",
  "GE_GROUP_ENTITY_FULL_NAME": "sample string 70",
  "strWithHoldingDateOfAllocationID": "sample string 71",
  "WithHoldingDateOfAllocationID": 72,
  "strWithHoldingDateOfAllocation": "sample string 73",
  "SelectedWithHoldingDateOfAllocation": "sample string 74",
  "UnSelectedWithHoldingDateOfAllocation": "sample string 75",
  "WithholdingName": "sample string 76",
  "StrINTERMIDIARY_INVESTOR": "sample string 77",
  "EndAlocationEntityIds": "sample string 78",
  "WithHoldingParameterModel": {
    "InvestorId": "sample string 1",
    "RecordId": "sample string 2",
    "InvestorType": "sample string 3",
    "RecipientStatus": "sample string 4",
    "TaxRecidency1": "sample string 5",
    "Name": "sample string 6",
    "Address": "sample string 7",
    "TIN_1": "sample string 8",
    "US_TIN": "sample string 9",
    "LOCAL_TAX_STATUS": "sample string 10",
    "US_TAX_NAME": "sample string 11",
    "CHAPTER_3_STATUS_CODE": "sample string 12",
    "CHAPTER_4_STATUS_CODE": "sample string 13",
    "GIIN": "sample string 14",
    "US_TAX_ID": "sample string 15"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseApiResponse
Name Description Type Additional information
Success

boolean

None.

Message

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": [
    "sample string 1",
    "sample string 2"
  ]
}