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

Add Tenant Deposit. Processes this lettings progression API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
roleId	The unique identifier of the role resource.	integer	Required

Body Parameters

The add tenant deposit data contract supplied with the request.

AddTenantDepositDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Deposit	The deposit value.	SetDepositCommandDataContract	None.
TenantChargeInfo	The tenant charge info value.	AddTenantChargeInfoDataContract	None.
HistoricDeposit	Indicates whether historic deposit is true.	boolean	None.
DateProtected	The date protected, expressed as a date and time.	date	None.
DepositSchemeId	The unique identifier of the related deposit scheme resource.	integer	None.
Id	The unique identifier of this resource.	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": "2026-07-23T08:26:04.1410319Z",
    "Id": 3
  },
  "HistoricDeposit": true,
  "DateProtected": "2026-07-23T08:26:04.1410319Z",
  "DepositSchemeId": 3,
  "Id": 4
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.