POST api/resident/moveout

Move a resident out of the Conservice System emails a final bill to the resident.

Request Information

Parameters

NameDescriptionAdditional information
request

Define this parameter in the request body.

Request body formats

application/json

Sample:
{
  "ManagementFirmName": "sample string 1",
  "PropertyId": "sample string 2",
  "ResidentId": "sample string 3",
  "UnitNumber": "sample string 4",
  "BuildingNumber": "sample string 5",
  "MoveOutDate": "sample DateTime 2024-05-28T10:06:15.4015111-06:00",
  "SubmittedBy": "sample string 7"
}

text/json

Sample:
{
  "ManagementFirmName": "sample string 1",
  "PropertyId": "sample string 2",
  "ResidentId": "sample string 3",
  "UnitNumber": "sample string 4",
  "BuildingNumber": "sample string 5",
  "MoveOutDate": "2024-09-19T11:41:28.9013688-06:00",
  "SubmittedBy": "sample string 7"
}

application/xml, text/xml

Sample:
<MoveOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorIntegration.ClientModels.BOL">
  <BuildingNumber>sample string 5</BuildingNumber>
  <ManagementFirmName>sample string 1</ManagementFirmName>
  <MoveOutDate>2024-09-19T11:41:28.9013688-06:00</MoveOutDate>
  <PropertyId>sample string 2</PropertyId>
  <ResidentId>sample string 3</ResidentId>
  <SubmittedBy>sample string 7</SubmittedBy>
  <UnitNumber>sample string 4</UnitNumber>
</MoveOutRequest>

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 'MoveOutRequest'.

Response Information

application/json

Sample:
{
  "ResidentTransaction": {
   "Property": [
    {
     "RTServiceTransactions": [ 
      {    
       Charge": {    
         Detail": {    
         "BatchID": "sample integer 1",
         "Description": "sample string 2",
         "TransactionDate": "sample DateTime 2024-05-29T10:59:48.1359246-06:00",
         "ServiceToDate": "sample DateTime 2024-05-29T10:59:48.1359246-06:00",
         "ChargeCode": "sample string 5",
         "GLAccountNumber": "{sample object} ",
         "CustomerID": "sample string 7",
         "UnitID": "sample string 8",
         "AmountPaid": "sample byte 64",
         "Amount": "sample decimal 10.0",
         "Comment": "sample string 11",
         "PropertyPrimaryID": "sample string 12" 
         }
        }
       }
      ]
     }
    ]
  },
  "Code": "sample string 7",
  "Message": "sample string 8",
  "Description": "sample string 9",
  "Link": "sample string 10"    
}

text/json

Sample:
{
  "ResidentTransaction": {
    "Property": [
      {
        "RTServiceTransactions": [
          {
            "Charge": {
              "Detail": {
                "BatchID": 1,
                "Description": "sample string 2",
                "TransactionDate": "2024-09-19T11:41:28.9013688-06:00",
                "ServiceToDate": "2024-09-19T11:41:28.9013688-06:00",
                "ChargeCode": "sample string 5",
                "GLAccountNumber": {},
                "CustomerID": "sample string 7",
                "UnitID": "sample string 8",
                "AmountPaid": 64,
                "Amount": 10.0,
                "Comment": "sample string 11",
                "PropertyPrimaryID": "sample string 12"
              }
            }
          },
          {
            "Charge": {
              "Detail": {
                "BatchID": 1,
                "Description": "sample string 2",
                "TransactionDate": "2024-09-19T11:41:28.9013688-06:00",
                "ServiceToDate": "2024-09-19T11:41:28.9013688-06:00",
                "ChargeCode": "sample string 5",
                "GLAccountNumber": {},
                "CustomerID": "sample string 7",
                "UnitID": "sample string 8",
                "AmountPaid": 64,
                "Amount": 10.0,
                "Comment": "sample string 11",
                "PropertyPrimaryID": "sample string 12"
              }
            }
          }
        ]
      },
      {
        "RTServiceTransactions": [
          {
            "Charge": {
              "Detail": {
                "BatchID": 1,
                "Description": "sample string 2",
                "TransactionDate": "2024-09-19T11:41:28.9013688-06:00",
                "ServiceToDate": "2024-09-19T11:41:28.9013688-06:00",
                "ChargeCode": "sample string 5",
                "GLAccountNumber": {},
                "CustomerID": "sample string 7",
                "UnitID": "sample string 8",
                "AmountPaid": 64,
                "Amount": 10.0,
                "Comment": "sample string 11",
                "PropertyPrimaryID": "sample string 12"
              }
            }
          },
          {
            "Charge": {
              "Detail": {
                "BatchID": 1,
                "Description": "sample string 2",
                "TransactionDate": "2024-09-19T11:41:28.9013688-06:00",
                "ServiceToDate": "2024-09-19T11:41:28.9013688-06:00",
                "ChargeCode": "sample string 5",
                "GLAccountNumber": {},
                "CustomerID": "sample string 7",
                "UnitID": "sample string 8",
                "AmountPaid": 64,
                "Amount": 10.0,
                "Comment": "sample string 11",
                "PropertyPrimaryID": "sample string 12"
              }
            }
          }
        ]
      }
    ]
  },
  "Code": "sample string 1",
  "Message": "sample string 2",
  "Description": "sample string 3",
  "Link": "sample string 4"
}

application/xml, text/xml

Sample:
<MoveOutResponse 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>
  <ResidentTransaction xmlns:d2p1="http://schemas.datacontract.org/2004/07/BillingCL.BOL">
    <d2p1:Property>
      <d2p1:ResidentTransactionsRT_Customer>
        <d2p1:RTServiceTransactions>
          <d2p1:ResidentTransactionsRT_CustomerTransactions>
            <d2p1:Charge>
              <d2p1:Detail>
                <d2p1:Amount>10</d2p1:Amount>
                <d2p1:AmountPaid>64</d2p1:AmountPaid>
                <d2p1:BatchID>1</d2p1:BatchID>
                <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
                <d2p1:Comment>sample string 11</d2p1:Comment>
                <d2p1:CustomerID>sample string 7</d2p1:CustomerID>
                <d2p1:Description>sample string 2</d2p1:Description>
                <d2p1:GLAccountNumber />
                <d2p1:PropertyPrimaryID>sample string 12</d2p1:PropertyPrimaryID>
                <d2p1:ServiceToDate>2024-09-19T11:41:28.9013688-06:00</d2p1:ServiceToDate>
                <d2p1:TransactionDate>2024-09-19T11:41:28.9013688-06:00</d2p1:TransactionDate>
                <d2p1:UnitID>sample string 8</d2p1:UnitID>
              </d2p1:Detail>
            </d2p1:Charge>
          </d2p1:ResidentTransactionsRT_CustomerTransactions>
          <d2p1:ResidentTransactionsRT_CustomerTransactions>
            <d2p1:Charge>
              <d2p1:Detail>
                <d2p1:Amount>10</d2p1:Amount>
                <d2p1:AmountPaid>64</d2p1:AmountPaid>
                <d2p1:BatchID>1</d2p1:BatchID>
                <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
                <d2p1:Comment>sample string 11</d2p1:Comment>
                <d2p1:CustomerID>sample string 7</d2p1:CustomerID>
                <d2p1:Description>sample string 2</d2p1:Description>
                <d2p1:GLAccountNumber />
                <d2p1:PropertyPrimaryID>sample string 12</d2p1:PropertyPrimaryID>
                <d2p1:ServiceToDate>2024-09-19T11:41:28.9013688-06:00</d2p1:ServiceToDate>
                <d2p1:TransactionDate>2024-09-19T11:41:28.9013688-06:00</d2p1:TransactionDate>
                <d2p1:UnitID>sample string 8</d2p1:UnitID>
              </d2p1:Detail>
            </d2p1:Charge>
          </d2p1:ResidentTransactionsRT_CustomerTransactions>
        </d2p1:RTServiceTransactions>
      </d2p1:ResidentTransactionsRT_Customer>
      <d2p1:ResidentTransactionsRT_Customer>
        <d2p1:RTServiceTransactions>
          <d2p1:ResidentTransactionsRT_CustomerTransactions>
            <d2p1:Charge>
              <d2p1:Detail>
                <d2p1:Amount>10</d2p1:Amount>
                <d2p1:AmountPaid>64</d2p1:AmountPaid>
                <d2p1:BatchID>1</d2p1:BatchID>
                <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
                <d2p1:Comment>sample string 11</d2p1:Comment>
                <d2p1:CustomerID>sample string 7</d2p1:CustomerID>
                <d2p1:Description>sample string 2</d2p1:Description>
                <d2p1:GLAccountNumber />
                <d2p1:PropertyPrimaryID>sample string 12</d2p1:PropertyPrimaryID>
                <d2p1:ServiceToDate>2024-09-19T11:41:28.9013688-06:00</d2p1:ServiceToDate>
                <d2p1:TransactionDate>2024-09-19T11:41:28.9013688-06:00</d2p1:TransactionDate>
                <d2p1:UnitID>sample string 8</d2p1:UnitID>
              </d2p1:Detail>
            </d2p1:Charge>
          </d2p1:ResidentTransactionsRT_CustomerTransactions>
          <d2p1:ResidentTransactionsRT_CustomerTransactions>
            <d2p1:Charge>
              <d2p1:Detail>
                <d2p1:Amount>10</d2p1:Amount>
                <d2p1:AmountPaid>64</d2p1:AmountPaid>
                <d2p1:BatchID>1</d2p1:BatchID>
                <d2p1:ChargeCode>sample string 5</d2p1:ChargeCode>
                <d2p1:Comment>sample string 11</d2p1:Comment>
                <d2p1:CustomerID>sample string 7</d2p1:CustomerID>
                <d2p1:Description>sample string 2</d2p1:Description>
                <d2p1:GLAccountNumber />
                <d2p1:PropertyPrimaryID>sample string 12</d2p1:PropertyPrimaryID>
                <d2p1:ServiceToDate>2024-09-19T11:41:28.9013688-06:00</d2p1:ServiceToDate>
                <d2p1:TransactionDate>2024-09-19T11:41:28.9013688-06:00</d2p1:TransactionDate>
                <d2p1:UnitID>sample string 8</d2p1:UnitID>
              </d2p1:Detail>
            </d2p1:Charge>
          </d2p1:ResidentTransactionsRT_CustomerTransactions>
        </d2p1:RTServiceTransactions>
      </d2p1:ResidentTransactionsRT_Customer>
    </d2p1:Property>
  </ResidentTransaction>
</MoveOutResponse>