Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| incomeId |
The income identifier. |
integer |
Required |
Body Parameters
The income.
Nano.Income| Name | Description | Type | Additional information |
|---|---|---|---|
| disposition |
Gets or sets the disposition. |
string |
None. |
| endDate |
Gets or sets the end date. |
string |
None. |
| hasNoEndDate |
Gets or sets a value indicating whether the income has no end date. |
boolean |
None. |
| hourlyRate |
Gets or sets the hourly rate. |
decimal number |
None. |
| hoursPerWeek |
Gets or sets the hours per week. |
decimal number |
None. |
| isForeign |
Gets or sets a value indicating whether income is foreign. |
boolean |
None. |
| isSeasonal |
Gets or sets a value indicating whether income is seasonal. |
boolean |
None. |
| monthlyAmount |
Gets or sets the monthly amount. |
decimal number |
None. |
| otherDescription |
Gets or sets the other description. |
string |
None. |
| startDate |
Gets or sets the start date. |
string |
None. |
| app |
Gets or sets the application identifier. |
integer |
None. |
| id |
Gets or sets the income identifier. |
integer |
None. |
| incomeType |
Gets or sets the income type identifier. |
integer |
None. |
| employers |
Gets or sets the employer identifiers. |
Collection of integer |
None. |
| persons |
Gets or sets the person identifiers. |
Collection of integer |
None. |
| verifications |
Gets or sets the verification identifiers. |
Collection of integer |
None. |
| verificationOrders |
Gets or sets the verification order identifiers. |
Collection of integer |
None. |
Request Formats
application/json, text/json
{
"disposition": "sample String 1",
"endDate": "sample String 2",
"hasNoEndDate": true,
"hourlyRate": 1.0,
"hoursPerWeek": 1.0,
"isForeign": true,
"isSeasonal": true,
"monthlyAmount": 1.0,
"otherDescription": "sample String 6",
"startDate": "sample String 7",
"app": "8",
"id": "9",
"incomeType": "1",
"employers": [
"1",
"2"
],
"persons": [
"1",
"2"
],
"verifications": [
"1",
"2"
],
"verificationOrders": [
"1",
"2"
]
}
text/html
{"disposition":"sample String 1","endDate":"sample String 2","hasNoEndDate":true,"hourlyRate":1.0,"hoursPerWeek":1.0,"isForeign":true,"isSeasonal":true,"monthlyAmount":1.0,"otherDescription":"sample String 6","startDate":"sample String 7","app":"8","id":"9","incomeType":"1","employers":["1","2"],"persons":["1","2"],"verifications":["1","2"],"verificationOrders":["1","2"]}
application/x-www-form-urlencoded
Sample not available.
application/vnd.api+json
Sample not available.
Response Information
Resource Description
The updated income.
Nano.Income| Name | Description | Type | Additional information |
|---|---|---|---|
| disposition |
Gets or sets the disposition. |
string |
None. |
| endDate |
Gets or sets the end date. |
string |
None. |
| hasNoEndDate |
Gets or sets a value indicating whether the income has no end date. |
boolean |
None. |
| hourlyRate |
Gets or sets the hourly rate. |
decimal number |
None. |
| hoursPerWeek |
Gets or sets the hours per week. |
decimal number |
None. |
| isForeign |
Gets or sets a value indicating whether income is foreign. |
boolean |
None. |
| isSeasonal |
Gets or sets a value indicating whether income is seasonal. |
boolean |
None. |
| monthlyAmount |
Gets or sets the monthly amount. |
decimal number |
None. |
| otherDescription |
Gets or sets the other description. |
string |
None. |
| startDate |
Gets or sets the start date. |
string |
None. |
| app |
Gets or sets the application identifier. |
integer |
None. |
| id |
Gets or sets the income identifier. |
integer |
None. |
| incomeType |
Gets or sets the income type identifier. |
integer |
None. |
| employers |
Gets or sets the employer identifiers. |
Collection of integer |
None. |
| persons |
Gets or sets the person identifiers. |
Collection of integer |
None. |
| verifications |
Gets or sets the verification identifiers. |
Collection of integer |
None. |
| verificationOrders |
Gets or sets the verification order identifiers. |
Collection of integer |
None. |
Response Formats
application/json, text/json
{
"disposition": "sample String 1",
"endDate": "sample String 2",
"hasNoEndDate": true,
"hourlyRate": 1.0,
"hoursPerWeek": 1.0,
"isForeign": true,
"isSeasonal": true,
"monthlyAmount": 1.0,
"otherDescription": "sample String 6",
"startDate": "sample String 7",
"app": "8",
"id": "9",
"incomeType": "1",
"employers": [
"1",
"2"
],
"persons": [
"1",
"2"
],
"verifications": [
"1",
"2"
],
"verificationOrders": [
"1",
"2"
]
}
text/html
{"disposition":"sample String 1","endDate":"sample String 2","hasNoEndDate":true,"hourlyRate":1.0,"hoursPerWeek":1.0,"isForeign":true,"isSeasonal":true,"monthlyAmount":1.0,"otherDescription":"sample String 6","startDate":"sample String 7","app":"8","id":"9","incomeType":"1","employers":["1","2"],"persons":["1","2"],"verifications":["1","2"],"verificationOrders":["1","2"]}
application/vnd.api+json
Sample not available.