GET api/residents/{residentId}/creditHistory?startDate={startDate}&endDate={endDate}

Get resident credit history. Exclusively used by Connect gRPC.

Request Information

URI Parameters

Name	Type	Additional information
residentId	integer	Required
startDate	date	None.
endDate	date	None.

Body Parameters

None.

Response Information

Resource Description

List of DetailedResidentCreditHistoryViewModel

Collection of DetailedResidentCreditHistoryViewModel

Name	Description	Type	Additional information
ReadableCreditHistoryCode		string	None.
CreditHistoryCodeDescription		string	None.
ResidentCreditHistoryId	ResidentCreditHistoryId	integer	None.
ResidentId	ResidentId	integer	None.
CreatedDate	CreatedDate	date	None.
CreditHistoryCodeId	CreditHistoryCodeId	integer	None.
Note	Note	string	None.
EffectiveDate	EffectiveDate	date	None.
CollectionsAgentId	CollectionsAgentId	integer	None.
UserId	UserId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "readableCreditHistoryCode": "sample string 1",
    "creditHistoryCodeDescription": "sample string 2",
    "residentCreditHistoryId": 3,
    "residentId": 4,
    "createdDate": "2024-10-14T08:21:43.0897812-04:00",
    "creditHistoryCodeId": 6,
    "note": "sample string 7",
    "effectiveDate": "2024-10-14T08:21:43.0897812-04:00",
    "collectionsAgentId": 1,
    "userId": 1
  },
  {
    "readableCreditHistoryCode": "sample string 1",
    "creditHistoryCodeDescription": "sample string 2",
    "residentCreditHistoryId": 3,
    "residentId": 4,
    "createdDate": "2024-10-14T08:21:43.0897812-04:00",
    "creditHistoryCodeId": 6,
    "note": "sample string 7",
    "effectiveDate": "2024-10-14T08:21:43.0897812-04:00",
    "collectionsAgentId": 1,
    "userId": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfDetailedResidentCreditHistoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <DetailedResidentCreditHistoryViewModel>
    <CollectionsAgentId>1</CollectionsAgentId>
    <CreatedDate>2024-10-14T08:21:43.0897812-04:00</CreatedDate>
    <CreditHistoryCodeId>6</CreditHistoryCodeId>
    <EffectiveDate>2024-10-14T08:21:43.0897812-04:00</EffectiveDate>
    <Note>sample string 7</Note>
    <ResidentCreditHistoryId>3</ResidentCreditHistoryId>
    <ResidentId>4</ResidentId>
    <UserId>1</UserId>
    <CreditHistoryCodeDescription>sample string 2</CreditHistoryCodeDescription>
    <ReadableCreditHistoryCode>sample string 1</ReadableCreditHistoryCode>
  </DetailedResidentCreditHistoryViewModel>
  <DetailedResidentCreditHistoryViewModel>
    <CollectionsAgentId>1</CollectionsAgentId>
    <CreatedDate>2024-10-14T08:21:43.0897812-04:00</CreatedDate>
    <CreditHistoryCodeId>6</CreditHistoryCodeId>
    <EffectiveDate>2024-10-14T08:21:43.0897812-04:00</EffectiveDate>
    <Note>sample string 7</Note>
    <ResidentCreditHistoryId>3</ResidentCreditHistoryId>
    <ResidentId>4</ResidentId>
    <UserId>1</UserId>
    <CreditHistoryCodeDescription>sample string 2</CreditHistoryCodeDescription>
    <ReadableCreditHistoryCode>sample string 1</ReadableCreditHistoryCode>
  </DetailedResidentCreditHistoryViewModel>
</ArrayOfDetailedResidentCreditHistoryViewModel>