POST api/progression/lettings/{roleId}/addtenantdeposit

Request Information

URI Parameters

Name	Description	Type	Additional information
roleId		integer	Required

Body Parameters

AddTenantDepositDataContract

Name	Type	Additional information
Name	string	None.
Deposit	SetDepositCommandDataContract	None.
TenantChargeInfo	AddTenantChargeInfoDataContract	None.
HistoricDeposit	boolean	None.
DateProtected	date	None.
DepositSchemeId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Deposit": {
    "PriceValue": 1.1,
    "CurrencyCode": "sample string 2",
    "Scheme": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "Status": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "DepositIdentification": "sample string 3",
    "Id": 4
  },
  "TenantChargeInfo": {
    "AmountPaid": 1.1,
    "DiscountPercentage": 2.1,
    "DueDate": "2025-07-03T04:27:55.694285Z",
    "Id": 3
  },
  "HistoricDeposit": true,
  "DateProtected": "2025-07-03T04:27:55.694285Z",
  "DepositSchemeId": 3,
  "Id": 4
}

Response Information

Resource Description

HttpResponseMessage

Name	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.