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

Get resident credit history detail

Request Information

URI Parameters

NameDescriptionTypeAdditional information
residentId

integer

Required

creditHistoryId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Resident credit history detail

DetailedResidentCreditHistoryViewModel
NameDescriptionTypeAdditional 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:44.4336794-04:00",
  "creditHistoryCodeId": 6,
  "note": "sample string 7",
  "effectiveDate": "2024-10-14T08:21:44.4336794-04:00",
  "collectionsAgentId": 1,
  "userId": 1
}

application/xml, text/xml

Sample:
<DetailedResidentCreditHistoryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <CollectionsAgentId>1</CollectionsAgentId>
  <CreatedDate>2024-10-14T08:21:44.4336794-04:00</CreatedDate>
  <CreditHistoryCodeId>6</CreditHistoryCodeId>
  <EffectiveDate>2024-10-14T08:21:44.4336794-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>