GET GetRentAccountLedger?PeriodId={PeriodId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
PeriodId

integer

Required

Body Parameters

None.

Response Information

Resource Description

RentAccountLedgerRepository
NameDescriptionTypeAdditional information
successful

boolean

None.
message

string

None.
data

RentAccountLedgerInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "successful": true,
  "message": "sample string 2",
  "data": {
    "balanceDue": 1.0,
    "dailyLate": 2.0,
    "totalDue": 3.0,
    "transactions": [
      {
        "period": "sample string 1",
        "description": "sample string 2",
        "documentNumber": "sample string 3",
        "charge": 4.0,
        "credit": 5.0,
        "taxAmount": 6.0,
        "balance": 7.0
      },
      {
        "period": "sample string 1",
        "description": "sample string 2",
        "documentNumber": "sample string 3",
        "charge": 4.0,
        "credit": 5.0,
        "taxAmount": 6.0,
        "balance": 7.0
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<RentAccountLedgerRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
  <data>
    <balanceDue>1</balanceDue>
    <dailyLate>2</dailyLate>
    <totalDue>3</totalDue>
    <transactions>
      <RentAccountLedgerTransactions>
        <balance>7</balance>
        <charge>4</charge>
        <credit>5</credit>
        <description>sample string 2</description>
        <documentNumber>sample string 3</documentNumber>
        <period>sample string 1</period>
        <taxAmount>6</taxAmount>
      </RentAccountLedgerTransactions>
      <RentAccountLedgerTransactions>
        <balance>7</balance>
        <charge>4</charge>
        <credit>5</credit>
        <description>sample string 2</description>
        <documentNumber>sample string 3</documentNumber>
        <period>sample string 1</period>
        <taxAmount>6</taxAmount>
      </RentAccountLedgerTransactions>
    </transactions>
  </data>
  <message>sample string 2</message>
  <successful>true</successful>
</RentAccountLedgerRepository>