POST 17.0/app/tenancy/createpretenancy

Description

Creates a pre-tenancy item based on the provided request details.

URI Parameters

None.

The request containing pre-tenancy information such as dates, amounts, and notes.

PreTenancyRequest
Name Description Type Additional information
PropertyId

integer

None.
ContactId

integer

None.
StartDate

date

None.
EndDate

date

None.
Interval

byte

None.
Duration

integer

None.
ManagementTypeId

integer

None.
Rent

decimal number

None.
RentPaymentFrequency

byte

None.
RentPaymentDay

byte

None.
Deposit

decimal number

None.
DepositHeldBy

byte

None.
BankAccountId

integer

None.
ReceivingPayment

boolean

None.
PaymentReceivedDate

date

None.
PaymentReceivedMethod

integer

None.
PaymentReceivedByUserId

integer

None.
SetupFees

Collection of SetupFeeItem

None.
HoldingDeposit

decimal number

None.
DeductHoldingDepositFrom

byte

None.
UpfrontRent

decimal number

None.
Notes

string

None.

application/json, text/json
Sample: 
{
  "propertyId": 1,
  "contactId": 2,
  "startDate": "2025-10-28T18:04",
  "endDate": "2025-10-28T18:04",
  "interval": 64,
  "duration": 6,
  "managementTypeId": 7,
  "rent": 8.0,
  "rentPaymentFrequency": 64,
  "rentPaymentDay": 64,
  "deposit": 11.0,
  "depositHeldBy": 64,
  "bankAccountId": 13,
  "receivingPayment": true,
  "paymentReceivedDate": "2025-10-28T18:04",
  "paymentReceivedMethod": 16,
  "paymentReceivedByUserId": 17,
  "setupFees": [
    {
      "amount": 1.0,
      "productId": 2,
      "taxRateId": 3,
      "taxRate": 4.0
    },
    {
      "amount": 1.0,
      "productId": 2,
      "taxRateId": 3,
      "taxRate": 4.0
    }
  ],
  "holdingDeposit": 18.0,
  "deductHoldingDepositFrom": 64,
  "upfrontRent": 20.0,
  "notes": "sample string 21"
}

application/xml, text/xml
Sample: 
<PreTenancyRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyId>1</PropertyId>
  <ContactId>2</ContactId>
  <StartDate>2025-10-28T18:04:27.1435344+00:00</StartDate>
  <EndDate>2025-10-28T18:04:27.1435344+00:00</EndDate>
  <Interval>64</Interval>
  <Duration>6</Duration>
  <ManagementTypeId>7</ManagementTypeId>
  <Rent>8</Rent>
  <RentPaymentFrequency>64</RentPaymentFrequency>
  <RentPaymentDay>64</RentPaymentDay>
  <Deposit>11</Deposit>
  <DepositHeldBy>64</DepositHeldBy>
  <BankAccountId>13</BankAccountId>
  <ReceivingPayment>true</ReceivingPayment>
  <PaymentReceivedDate>2025-10-28T18:04:27.1435344+00:00</PaymentReceivedDate>
  <PaymentReceivedMethod>16</PaymentReceivedMethod>
  <PaymentReceivedByUserId>17</PaymentReceivedByUserId>
  <SetupFees>
    <SetupFeeItem>
      <Amount>1</Amount>
      <ProductId>2</ProductId>
      <TaxRateId>3</TaxRateId>
      <TaxRate>4</TaxRate>
    </SetupFeeItem>
    <SetupFeeItem>
      <Amount>1</Amount>
      <ProductId>2</ProductId>
      <TaxRateId>3</TaxRateId>
      <TaxRate>4</TaxRate>
    </SetupFeeItem>
  </SetupFees>
  <HoldingDeposit>18</HoldingDeposit>
  <DeductHoldingDepositFrom>64</DeductHoldingDepositFrom>
  <UpfrontRent>20</UpfrontRent>
  <Notes>sample string 21</Notes>
</PreTenancyRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

An IHttpActionResult containing the created PreTenancyItem.

PreTenancyItem
Name Description Type Additional information
TenancyId

integer

None.
ReceiptId

integer

None.
InvoiceId

integer

None.

application/json, text/json
Sample: 
{
  "tenancyId": 1,
  "receiptId": 2,
  "invoiceId": 3
}

application/xml, text/xml
Sample: 
<PreTenancyItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TenancyId>1</TenancyId>
  <ReceiptId>2</ReceiptId>
  <InvoiceId>3</InvoiceId>
</PreTenancyItem>