GET api/residents/{residentId}/creditHistory/all

Get Resident Credit History All

Request Information

URI Parameters

Name	Description	Type	Additional information
residentId	Primary Resident Identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

List of ResidentCreditHistoryListViewModel

Collection of ResidentCreditHistoryItemViewModel

Name	Type	Additional information
ResidentCreditHistoryId	integer	None.
ReadableCreditHistoryCode	string	None.
CreditHistoryCodeDescription	string	None.
Note	string	None.
CreatedDate	date	None.
EffectiveDate	date	None.
Balance	decimal number	None.
CollectionAgent	ResidentCreditHistoryCollectionAgentViewModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "residentCreditHistoryId": 1,
    "readableCreditHistoryCode": "sample string 2",
    "creditHistoryCodeDescription": "sample string 3",
    "note": "sample string 4",
    "createdDate": "2024-10-14T08:26:30.4504783-04:00",
    "effectiveDate": "2024-10-14T08:26:30.4504783-04:00",
    "balance": 6.0,
    "collectionAgent": {
      "agencyName": "sample string 1",
      "contactName": "sample string 2",
      "contactPhoneNumber": "sample string 3",
      "contactEmail": "sample string 4"
    }
  },
  {
    "residentCreditHistoryId": 1,
    "readableCreditHistoryCode": "sample string 2",
    "creditHistoryCodeDescription": "sample string 3",
    "note": "sample string 4",
    "createdDate": "2024-10-14T08:26:30.4504783-04:00",
    "effectiveDate": "2024-10-14T08:26:30.4504783-04:00",
    "balance": 6.0,
    "collectionAgent": {
      "agencyName": "sample string 1",
      "contactName": "sample string 2",
      "contactPhoneNumber": "sample string 3",
      "contactEmail": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfResidentCreditHistoryItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ResidentCreditHistoryItemViewModel>
    <Balance>6</Balance>
    <CollectionAgent>
      <AgencyName>sample string 1</AgencyName>
      <ContactEmail>sample string 4</ContactEmail>
      <ContactName>sample string 2</ContactName>
      <ContactPhoneNumber>sample string 3</ContactPhoneNumber>
    </CollectionAgent>
    <CreatedDate>2024-10-14T08:26:30.4504783-04:00</CreatedDate>
    <CreditHistoryCodeDescription>sample string 3</CreditHistoryCodeDescription>
    <EffectiveDate>2024-10-14T08:26:30.4504783-04:00</EffectiveDate>
    <Note>sample string 4</Note>
    <ReadableCreditHistoryCode>sample string 2</ReadableCreditHistoryCode>
    <ResidentCreditHistoryId>1</ResidentCreditHistoryId>
  </ResidentCreditHistoryItemViewModel>
  <ResidentCreditHistoryItemViewModel>
    <Balance>6</Balance>
    <CollectionAgent>
      <AgencyName>sample string 1</AgencyName>
      <ContactEmail>sample string 4</ContactEmail>
      <ContactName>sample string 2</ContactName>
      <ContactPhoneNumber>sample string 3</ContactPhoneNumber>
    </CollectionAgent>
    <CreatedDate>2024-10-14T08:26:30.4504783-04:00</CreatedDate>
    <CreditHistoryCodeDescription>sample string 3</CreditHistoryCodeDescription>
    <EffectiveDate>2024-10-14T08:26:30.4504783-04:00</EffectiveDate>
    <Note>sample string 4</Note>
    <ReadableCreditHistoryCode>sample string 2</ReadableCreditHistoryCode>
    <ResidentCreditHistoryId>1</ResidentCreditHistoryId>
  </ResidentCreditHistoryItemViewModel>
</ArrayOfResidentCreditHistoryItemViewModel>