GET api/Principal/GetPrincipalListingByAccountIDExtended?accountID={accountID}&showInactive={showInactive}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
accountID

integer

Required
showInactive

boolean

Required

Body Parameters

None.

Response Information

Resource Description

PrincipalExtendedListVM
NameDescriptionTypeAdditional information
PrincipalSummaryList

Collection of PrincipalSummaryByAccountIDExtended

None.
CurrencyCharacter

string

None.
NumberOfResults

integer

None.
Response

IResponse

None.

Response Formats

application/json, text/json

Sample: 
{
  "PrincipalSummaryList": [
    {
      "PrincipalID": 1,
      "TransactionDesc": "sample string 2",
      "TransactionDate": "2025-09-02T23:08:33.3026251+00:00",
      "TransactionAmount": 4.0,
      "Allocation": 5.0,
      "Balance": 1.0,
      "NextActionDate": "2025-09-02T23:08:33.3026251+00:00",
      "ShortDescription": "sample string 6",
      "PrincipalStatus": "sample string 7",
      "PrincipalTypeCategory": "sample string 8",
      "PrincipalType": "sample string 9",
      "CreateBy": "sample string 10",
      "ContactID": 1,
      "CauseOfAction": "sample string 11",
      "COAStart": "2025-09-02T23:08:33.3026251+00:00",
      "COAEnd": "2025-09-02T23:08:33.3026251+00:00",
      "ReminderNoticeIssueDate": "2025-09-02T23:08:33.3026251+00:00",
      "DebtReferralStatus": "sample string 12",
      "IssuingEntity": "sample string 13",
      "PaymentRefNumber": "sample string 14",
      "ExternalRefNo": "sample string 15",
      "ExternalReturnToSenderCode": "sample string 16",
      "ExternalPreviousContact": true,
      "ExternalReview": true,
      "PreviousReviewOfEnforcement": true,
      "StartDate": "2025-09-02T23:08:33.3026251+00:00",
      "VehicleRegistration": "sample string 17",
      "VehicleLocation": "sample string 18",
      "Active": true,
      "Aggregated": true,
      "DueDate": "2025-09-02T23:08:33.3026251+00:00",
      "InactiveReason": "sample string 19",
      "ModifyBy": "sample string 20"
    },
    {
      "PrincipalID": 1,
      "TransactionDesc": "sample string 2",
      "TransactionDate": "2025-09-02T23:08:33.3026251+00:00",
      "TransactionAmount": 4.0,
      "Allocation": 5.0,
      "Balance": 1.0,
      "NextActionDate": "2025-09-02T23:08:33.3026251+00:00",
      "ShortDescription": "sample string 6",
      "PrincipalStatus": "sample string 7",
      "PrincipalTypeCategory": "sample string 8",
      "PrincipalType": "sample string 9",
      "CreateBy": "sample string 10",
      "ContactID": 1,
      "CauseOfAction": "sample string 11",
      "COAStart": "2025-09-02T23:08:33.3026251+00:00",
      "COAEnd": "2025-09-02T23:08:33.3026251+00:00",
      "ReminderNoticeIssueDate": "2025-09-02T23:08:33.3026251+00:00",
      "DebtReferralStatus": "sample string 12",
      "IssuingEntity": "sample string 13",
      "PaymentRefNumber": "sample string 14",
      "ExternalRefNo": "sample string 15",
      "ExternalReturnToSenderCode": "sample string 16",
      "ExternalPreviousContact": true,
      "ExternalReview": true,
      "PreviousReviewOfEnforcement": true,
      "StartDate": "2025-09-02T23:08:33.3026251+00:00",
      "VehicleRegistration": "sample string 17",
      "VehicleLocation": "sample string 18",
      "Active": true,
      "Aggregated": true,
      "DueDate": "2025-09-02T23:08:33.3026251+00:00",
      "InactiveReason": "sample string 19",
      "ModifyBy": "sample string 20"
    }
  ],
  "CurrencyCharacter": "sample string 1",
  "NumberOfResults": 1,
  "Response": null
}

application/xml, text/xml

Sample: 
<PrincipalExtendedListVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <CurrencyCharacter>sample string 1</CurrencyCharacter>
  <NumberOfResults>1</NumberOfResults>
  <PrincipalSummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
    <d2p1:PrincipalSummaryByAccountIDExtended>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Aggregated>true</d2p1:Aggregated>
      <d2p1:Allocation>5</d2p1:Allocation>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:COAEnd>2025-09-02T23:08:33.3026251+00:00</d2p1:COAEnd>
      <d2p1:COAStart>2025-09-02T23:08:33.3026251+00:00</d2p1:COAStart>
      <d2p1:CauseOfAction>sample string 11</d2p1:CauseOfAction>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:CreateBy>sample string 10</d2p1:CreateBy>
      <d2p1:DebtReferralStatus>sample string 12</d2p1:DebtReferralStatus>
      <d2p1:DueDate>2025-09-02T23:08:33.3026251+00:00</d2p1:DueDate>
      <d2p1:ExternalPreviousContact>true</d2p1:ExternalPreviousContact>
      <d2p1:ExternalRefNo>sample string 15</d2p1:ExternalRefNo>
      <d2p1:ExternalReturnToSenderCode>sample string 16</d2p1:ExternalReturnToSenderCode>
      <d2p1:ExternalReview>true</d2p1:ExternalReview>
      <d2p1:InactiveReason>sample string 19</d2p1:InactiveReason>
      <d2p1:IssuingEntity>sample string 13</d2p1:IssuingEntity>
      <d2p1:ModifyBy>sample string 20</d2p1:ModifyBy>
      <d2p1:NextActionDate>2025-09-02T23:08:33.3026251+00:00</d2p1:NextActionDate>
      <d2p1:PaymentRefNumber>sample string 14</d2p1:PaymentRefNumber>
      <d2p1:PreviousReviewOfEnforcement>true</d2p1:PreviousReviewOfEnforcement>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 7</d2p1:PrincipalStatus>
      <d2p1:PrincipalType>sample string 9</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategory>sample string 8</d2p1:PrincipalTypeCategory>
      <d2p1:ReminderNoticeIssueDate>2025-09-02T23:08:33.3026251+00:00</d2p1:ReminderNoticeIssueDate>
      <d2p1:ShortDescription>sample string 6</d2p1:ShortDescription>
      <d2p1:StartDate>2025-09-02T23:08:33.3026251+00:00</d2p1:StartDate>
      <d2p1:TransactionAmount>4</d2p1:TransactionAmount>
      <d2p1:TransactionDate>2025-09-02T23:08:33.3026251+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 2</d2p1:TransactionDesc>
      <d2p1:VehicleLocation>sample string 18</d2p1:VehicleLocation>
      <d2p1:VehicleRegistration>sample string 17</d2p1:VehicleRegistration>
    </d2p1:PrincipalSummaryByAccountIDExtended>
    <d2p1:PrincipalSummaryByAccountIDExtended>
      <d2p1:Active>true</d2p1:Active>
      <d2p1:Aggregated>true</d2p1:Aggregated>
      <d2p1:Allocation>5</d2p1:Allocation>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:COAEnd>2025-09-02T23:08:33.3026251+00:00</d2p1:COAEnd>
      <d2p1:COAStart>2025-09-02T23:08:33.3026251+00:00</d2p1:COAStart>
      <d2p1:CauseOfAction>sample string 11</d2p1:CauseOfAction>
      <d2p1:ContactID>1</d2p1:ContactID>
      <d2p1:CreateBy>sample string 10</d2p1:CreateBy>
      <d2p1:DebtReferralStatus>sample string 12</d2p1:DebtReferralStatus>
      <d2p1:DueDate>2025-09-02T23:08:33.3026251+00:00</d2p1:DueDate>
      <d2p1:ExternalPreviousContact>true</d2p1:ExternalPreviousContact>
      <d2p1:ExternalRefNo>sample string 15</d2p1:ExternalRefNo>
      <d2p1:ExternalReturnToSenderCode>sample string 16</d2p1:ExternalReturnToSenderCode>
      <d2p1:ExternalReview>true</d2p1:ExternalReview>
      <d2p1:InactiveReason>sample string 19</d2p1:InactiveReason>
      <d2p1:IssuingEntity>sample string 13</d2p1:IssuingEntity>
      <d2p1:ModifyBy>sample string 20</d2p1:ModifyBy>
      <d2p1:NextActionDate>2025-09-02T23:08:33.3026251+00:00</d2p1:NextActionDate>
      <d2p1:PaymentRefNumber>sample string 14</d2p1:PaymentRefNumber>
      <d2p1:PreviousReviewOfEnforcement>true</d2p1:PreviousReviewOfEnforcement>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 7</d2p1:PrincipalStatus>
      <d2p1:PrincipalType>sample string 9</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategory>sample string 8</d2p1:PrincipalTypeCategory>
      <d2p1:ReminderNoticeIssueDate>2025-09-02T23:08:33.3026251+00:00</d2p1:ReminderNoticeIssueDate>
      <d2p1:ShortDescription>sample string 6</d2p1:ShortDescription>
      <d2p1:StartDate>2025-09-02T23:08:33.3026251+00:00</d2p1:StartDate>
      <d2p1:TransactionAmount>4</d2p1:TransactionAmount>
      <d2p1:TransactionDate>2025-09-02T23:08:33.3026251+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 2</d2p1:TransactionDesc>
      <d2p1:VehicleLocation>sample string 18</d2p1:VehicleLocation>
      <d2p1:VehicleRegistration>sample string 17</d2p1:VehicleRegistration>
    </d2p1:PrincipalSummaryByAccountIDExtended>
  </PrincipalSummaryList>
</PrincipalExtendedListVM>