Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| forwardCommitmentId |
The forward commitment identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The forward commitment, if it exists.
Nano.ForwardCommitment| Name | Description | Type | Additional information |
|---|---|---|---|
| description |
Gets or sets the description. |
string |
None. |
| endDate |
Gets or sets the end date. |
date |
None. |
| externalIdentifier |
Gets or sets the externalIdentifier. |
string |
None. |
| isActive |
Gets or sets a value indicating whether forward commitment is active. |
boolean |
None. |
| startDate |
Gets or sets the start date. |
date |
None. |
| community |
Gets or sets the community identifier. |
integer |
None. |
| corporatePartner |
Gets or sets the corporate partner identifier. |
integer |
None. |
| id |
Gets or sets the community identifier. |
integer |
None. |
| organization |
Gets or sets the organization identifier. |
string |
None. |
| loanProducts |
Gets or sets the loan product identifier. |
Collection of integer |
None. |
| users |
Gets or sets the user identifiers. |
Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"description": "sample String 1",
"endDate": "2025-04-25T18:11:02.1858322Z",
"externalIdentifier": "sample String 2",
"isActive": true,
"startDate": "2025-04-25T18:11:02.1858322Z",
"community": "1",
"corporatePartner": "1",
"id": "5",
"organization": "sample String 6",
"loanProducts": [
"1",
"2"
],
"users": [
"1",
"2"
]
}
text/html
Sample:
{"description":"sample String 1","endDate":"2025-04-25T18:11:02.1858322Z","externalIdentifier":"sample String 2","isActive":true,"startDate":"2025-04-25T18:11:02.1858322Z","community":"1","corporatePartner":"1","id":"5","organization":"sample String 6","loanProducts":["1","2"],"users":["1","2"]}
application/vnd.api+json
Sample:
Sample not available.