Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| incomeTypeId |
The income type identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The income type, if it exists.
Nano.IncomeType| Name | Description | Type | Additional information |
|---|---|---|---|
| code |
Gets or sets the code. |
string |
None. |
| description |
Gets or sets the description. |
string |
None. |
| displayOrder |
Gets or sets the display order. |
integer |
None. |
| fnmaCode |
Gets or sets the FNMA code. |
string |
None. |
| isActive |
Gets or sets a value indicating whether this is active. |
boolean |
None. |
| isMilitaryEntitlement |
Gets or sets a value indicating whether the income type is military entitlement. |
boolean |
None. |
| isOther |
Gets or sets a value indicating whether the income type is other. |
boolean |
None. |
| isPublic |
Gets or sets a value indicating whether this is public. |
boolean |
None. |
| mismoType |
Gets or sets the mismo type. |
string |
None. |
| id |
Gets or sets the income type identifier. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"code": "sample String 1",
"description": "sample String 2",
"displayOrder": 3,
"fnmaCode": "sample String 4",
"isActive": true,
"isMilitaryEntitlement": true,
"isOther": true,
"isPublic": true,
"mismoType": "sample String 9",
"id": "10"
}
text/html
Sample:
{"code":"sample String 1","description":"sample String 2","displayOrder":3,"fnmaCode":"sample String 4","isActive":true,"isMilitaryEntitlement":true,"isOther":true,"isPublic":true,"mismoType":"sample String 9","id":"10"}
application/xml, text/xml
Sample:
<IncomeType xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Code>sample String 1</Code> <Description>sample String 2</Description> <DisplayOrder>3</DisplayOrder> <FNMACode>sample String 4</FNMACode> <IsActive>true</IsActive> <IsMilitaryEntitlement>true</IsMilitaryEntitlement> <IsOther>true</IsOther> <IsPublic>true</IsPublic> <MISMOType>sample String 9</MISMOType> <IncomeTypeId>10</IncomeTypeId> </IncomeType>
application/vnd.api+json
Sample:
Sample not available.