PUT api/MIncomes/Save?preApprovalID={preApprovalID}
Creates or updates Monthly Incomes and Liabilities
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
preApprovalID |
ID of PreApproval object |
string |
None. |
Body Parameters
MIncomeEntityName | Description | Type | Additional information |
---|---|---|---|
MIncomeID |
ID of Monthly Income |
string |
None. |
MonthlyIncome |
OBSOLETE. Monthly income |
decimal number |
None. |
Liabilities |
OBSOLETE. Household liablities |
decimal number |
None. |
NoofDependants |
Number for kids |
integer |
None. |
AgeofDependants |
if Number of kids is specidied, age of kids should be specified using comma. example '2,4' |
string |
None. |
MaritalStatus |
Marital status: Unmarried='U', Married='M', Separated='S', Divorced='D', Widow='W', Engaged='E', Other='O' |
string |
None. |
DependantsSupportedTogether |
Yes if dependants are supported together with Spouse, otherwise = N |
string |
None. |
CourtDecisionForSupportExists |
If DependantsSupportedTogether=N, then ask question bellow |
string |
None. |
AmountOfSupport |
If CourtDecisionForSupportExists=Y, then require amount |
decimal number |
None. |
IncomeDetails |
Structure of Income |
Collection of MIncomeItemEntity |
None. |
LiabilityDetails |
Structure of Liabilities |
Collection of LiabilityItemEntity |
None. |
Request Formats
application/json, text/json
Sample:
{ "IncomeDetails": [ { "TypeID": "sample string 1", "TranslationKey": "sample string 2", "Amount": 1.0, "CircumstancesExists": "sample string 3", "CircumstanceDescription": "sample string 4", "CircumstanceDescRequired": "sample string 5", "SortingOrder": 6 }, { "TypeID": "sample string 1", "TranslationKey": "sample string 2", "Amount": 1.0, "CircumstancesExists": "sample string 3", "CircumstanceDescription": "sample string 4", "CircumstanceDescRequired": "sample string 5", "SortingOrder": 6 } ], "LiabilityDetails": [ { "TypeID": "sample string 1", "TranslationKey": "sample string 2", "Amount": 1.0, "HasLiability": "sample string 3", "Description": "sample string 4", "DescriptionIsRequired": "sample string 5", "SortingOrder": 6 }, { "TypeID": "sample string 1", "TranslationKey": "sample string 2", "Amount": 1.0, "HasLiability": "sample string 3", "Description": "sample string 4", "DescriptionIsRequired": "sample string 5", "SortingOrder": 6 } ], "MIncomeID": "sample string 1", "MonthlyIncome": 2.0, "Liabilities": 3.0, "NoofDependants": 4, "AgeofDependants": "sample string 5", "MaritalStatus": "sample string 6", "DependantsSupportedTogether": "sample string 7", "CourtDecisionForSupportExists": "sample string 8", "AmountOfSupport": 1.0 }
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. |