POST api/resident/ledger

Returns a resident's account ledger as current on the Conservice system.

Request Information

Parameters

Name	Description	Additional information
request		Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "ManagementFirmName": "sample string 1",
  "PropertyCode": "sample string 2",
  "ResidentId": "sample string 3"
}

application/xml, text/xml

Sample:

<LedgerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <ManagementFirmName>sample string 1</ManagementFirmName>
  <PropertyCode>sample string 2</PropertyCode>
  <ResidentId>sample string 3</ResidentId>
</LedgerRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LedgerRequest'.

Response Information

application/json

Sample:

{
   "ResidentLedger": [ 
    {    
     "DueDate": "sample DateTime 2024-05-29T10:59:48.1359246-06:00",
     "MailDate": "sample DateTime 2024-05-29T10:59:48.1359246-06:00",
     "Description": "sample string 1",
     "Charge": "sample decimal 2.0",
     "Payment": "sample decimal 3.0",
     "MonthTotal": "sample string 4" 
    }
   ],
   "Code": "sample string 7",
   "Message": "sample string 8",
   "Description": "sample string 9",
   "Link": "sample string 10"    
}

text/json

Sample:

{
  "ResidentLedger": [
    {
      "DueDate": "2024-11-24T22:02:28.5474986-07:00",
      "MailDate": "2024-11-24T22:02:28.5474986-07:00",
      "Description": "sample string 1",
      "Charge": 2.0,
      "Payment": 3.0,
      "MonthTotal": "sample string 4"
    },
    {
      "DueDate": "2024-11-24T22:02:28.5474986-07:00",
      "MailDate": "2024-11-24T22:02:28.5474986-07:00",
      "Description": "sample string 1",
      "Charge": 2.0,
      "Payment": 3.0,
      "MonthTotal": "sample string 4"
    }
  ],
  "Code": "sample string 1",
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Link": "sample string 4"
}

application/xml, text/xml

Sample:

<LedgerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <Code>sample string 1</Code>
  <Description>sample string 3</Description>
  <Link>sample string 4</Link>
  <Message>sample string 2</Message>
  <ResidentLedger xmlns:d2p1="http://schemas.datacontract.org/2004/07/BillingCL.BOL.RESIDENT">
    <d2p1:LedgerItem>
      <d2p1:Charge>2</d2p1:Charge>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:DueDate>2024-11-24T22:02:28.5474986-07:00</d2p1:DueDate>
      <d2p1:MailDate>2024-11-24T22:02:28.5474986-07:00</d2p1:MailDate>
      <d2p1:MonthTotal>sample string 4</d2p1:MonthTotal>
      <d2p1:Payment>3</d2p1:Payment>
    </d2p1:LedgerItem>
    <d2p1:LedgerItem>
      <d2p1:Charge>2</d2p1:Charge>
      <d2p1:Description>sample string 1</d2p1:Description>
      <d2p1:DueDate>2024-11-24T22:02:28.5474986-07:00</d2p1:DueDate>
      <d2p1:MailDate>2024-11-24T22:02:28.5474986-07:00</d2p1:MailDate>
      <d2p1:MonthTotal>sample string 4</d2p1:MonthTotal>
      <d2p1:Payment>3</d2p1:Payment>
    </d2p1:LedgerItem>
  </ResidentLedger>
</LedgerResponse>