POST api/deposit/landlord/transfer
Transfer To Landlord. Processes this deposit API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
The move deposit to landlord data contract supplied with the request.
MoveDepositToLandlordDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TenantRoleId |
The unique identifier of the related tenant role resource. |
integer |
None. |
| ClientAccountId |
The unique identifier of the related client account resource. |
integer |
None. |
| AllocationIds |
The unique identifiers of the related allocation resources. |
Collection of integer |
None. |
| PropertyAccountId |
The unique identifier of the related property account resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"TenantRoleId": 1,
"ClientAccountId": 2,
"AllocationIds": [
1,
2
],
"PropertyAccountId": 1
}
Response Information
Resource Description
The response returned after the operation completes.
LedgerLineTransactionDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| DrCr |
The dr cr value. |
string |
None. |
| Amount |
The amount value. |
decimal number |
None. |
| AccountId |
The unique identifier of the related account resource. |
integer |
None. |
| AccountType |
The account type value. |
string |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"DrCr": "sample string 1",
"Amount": 2.0,
"AccountId": 3,
"AccountType": "sample string 4",
"Id": 5
}