GET GetDepositList

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

DepositListRepository
NameDescriptionTypeAdditional information
successful

boolean

None.
message

string

None.
data

DepositListInfo

None.
datainfo

DepositInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "successful": true,
  "message": "sample string 2",
  "data": {
    "totalDue": 1.0,
    "currentDue": 2.0,
    "depositListTransactions": [
      {
        "depositId": 1,
        "transactionCode": "sample string 2",
        "depositDescription": "sample string 3",
        "depositAmount": 4.0,
        "paid": 5.0,
        "due": 6.0,
        "depositTermId": 7,
        "depositTransactionCodeId": 8
      },
      {
        "depositId": 1,
        "transactionCode": "sample string 2",
        "depositDescription": "sample string 3",
        "depositAmount": 4.0,
        "paid": 5.0,
        "due": 6.0,
        "depositTermId": 7,
        "depositTransactionCodeId": 8
      }
    ]
  },
  "datainfo": {
    "totalDue": 1.0,
    "currentDue": 2.0,
    "depositCharges": [
      {
        "depositId": 1,
        "depositDescription": "sample string 2",
        "amount": 3.0,
        "depositTerms": [
          {
            "depositId": 1,
            "dueDate": "sample string 2",
            "amount": 3.0,
            "paid": 4.0,
            "balanceDue": 5.0
          },
          {
            "depositId": 1,
            "dueDate": "sample string 2",
            "amount": 3.0,
            "paid": 4.0,
            "balanceDue": 5.0
          }
        ]
      },
      {
        "depositId": 1,
        "depositDescription": "sample string 2",
        "amount": 3.0,
        "depositTerms": [
          {
            "depositId": 1,
            "dueDate": "sample string 2",
            "amount": 3.0,
            "paid": 4.0,
            "balanceDue": 5.0
          },
          {
            "depositId": 1,
            "dueDate": "sample string 2",
            "amount": 3.0,
            "paid": 4.0,
            "balanceDue": 5.0
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<DepositListRepository xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cybersoft.YottaResident.WebAPIs.Services">
  <data>
    <currentDue>2</currentDue>
    <depositListTransactions>
      <DepositListTransactions>
        <depositAmount>4</depositAmount>
        <depositDescription>sample string 3</depositDescription>
        <depositId>1</depositId>
        <depositTermId>7</depositTermId>
        <depositTransactionCodeId>8</depositTransactionCodeId>
        <due>6</due>
        <paid>5</paid>
        <transactionCode>sample string 2</transactionCode>
      </DepositListTransactions>
      <DepositListTransactions>
        <depositAmount>4</depositAmount>
        <depositDescription>sample string 3</depositDescription>
        <depositId>1</depositId>
        <depositTermId>7</depositTermId>
        <depositTransactionCodeId>8</depositTransactionCodeId>
        <due>6</due>
        <paid>5</paid>
        <transactionCode>sample string 2</transactionCode>
      </DepositListTransactions>
    </depositListTransactions>
    <totalDue>1</totalDue>
  </data>
  <datainfo>
    <currentDue>2</currentDue>
    <depositCharges>
      <DepositCharges>
        <amount>3</amount>
        <depositDescription>sample string 2</depositDescription>
        <depositId>1</depositId>
        <depositTerms>
          <DepositTerms>
            <amount>3</amount>
            <balanceDue>5</balanceDue>
            <depositId>1</depositId>
            <dueDate>sample string 2</dueDate>
            <paid>4</paid>
          </DepositTerms>
          <DepositTerms>
            <amount>3</amount>
            <balanceDue>5</balanceDue>
            <depositId>1</depositId>
            <dueDate>sample string 2</dueDate>
            <paid>4</paid>
          </DepositTerms>
        </depositTerms>
      </DepositCharges>
      <DepositCharges>
        <amount>3</amount>
        <depositDescription>sample string 2</depositDescription>
        <depositId>1</depositId>
        <depositTerms>
          <DepositTerms>
            <amount>3</amount>
            <balanceDue>5</balanceDue>
            <depositId>1</depositId>
            <dueDate>sample string 2</dueDate>
            <paid>4</paid>
          </DepositTerms>
          <DepositTerms>
            <amount>3</amount>
            <balanceDue>5</balanceDue>
            <depositId>1</depositId>
            <dueDate>sample string 2</dueDate>
            <paid>4</paid>
          </DepositTerms>
        </depositTerms>
      </DepositCharges>
    </depositCharges>
    <totalDue>1</totalDue>
  </datainfo>
  <message>sample string 2</message>
  <successful>true</successful>
</DepositListRepository>