POST api/PrincipalFinancialHistory/GetPrincipalFinancialHistorySummary

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrincipalList		Collection of PrincipalSelectableVM	None.
PrincipalFinancialHistorySummaryList		Collection of PrincipalFinancialHistorySummary	None.

Request Formats

application/json, text/json

Sample:

{
  "PrincipalList": [
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    },
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    }
  ],
  "PrincipalFinancialHistorySummaryList": [
    {
      "PrincipalID": 1,
      "TransactionID": 2,
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "PrincipalDescription": "sample string 3",
      "Description": "sample string 4",
      "Debit": 1.0,
      "Credit": 1.0,
      "Balance": 1.0,
      "TransactionType": "sample string 5",
      "PrincipalComponentType": "sample string 6",
      "TransactionDisplayID": 7
    },
    {
      "PrincipalID": 1,
      "TransactionID": 2,
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "PrincipalDescription": "sample string 3",
      "Description": "sample string 4",
      "Debit": 1.0,
      "Credit": 1.0,
      "Balance": 1.0,
      "TransactionType": "sample string 5",
      "PrincipalComponentType": "sample string 6",
      "TransactionDisplayID": 7
    }
  ]
}

application/xml, text/xml

Sample:

<PrincipalFinancialHistoryVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.PrincipalFinancialHistory">
  <PrincipalFinancialHistorySummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
    <d2p1:PrincipalFinancialHistorySummary>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:Credit>1</d2p1:Credit>
      <d2p1:Debit>1</d2p1:Debit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:PrincipalComponentType>sample string 6</d2p1:PrincipalComponentType>
      <d2p1:PrincipalDescription>sample string 3</d2p1:PrincipalDescription>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDisplayID>7</d2p1:TransactionDisplayID>
      <d2p1:TransactionID>2</d2p1:TransactionID>
      <d2p1:TransactionType>sample string 5</d2p1:TransactionType>
    </d2p1:PrincipalFinancialHistorySummary>
    <d2p1:PrincipalFinancialHistorySummary>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:Credit>1</d2p1:Credit>
      <d2p1:Debit>1</d2p1:Debit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:PrincipalComponentType>sample string 6</d2p1:PrincipalComponentType>
      <d2p1:PrincipalDescription>sample string 3</d2p1:PrincipalDescription>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDisplayID>7</d2p1:TransactionDisplayID>
      <d2p1:TransactionID>2</d2p1:TransactionID>
      <d2p1:TransactionType>sample string 5</d2p1:TransactionType>
    </d2p1:PrincipalFinancialHistorySummary>
  </PrincipalFinancialHistorySummaryList>
  <PrincipalList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal">
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
  </PrincipalList>
</PrincipalFinancialHistoryVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PrincipalFinancialHistoryVM

Name	Description	Type	Additional information
PrincipalList		Collection of PrincipalSelectableVM	None.
PrincipalFinancialHistorySummaryList		Collection of PrincipalFinancialHistorySummary	None.

Response Formats

application/json, text/json

Sample:

{
  "PrincipalList": [
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    },
    {
      "PrincipalID": 1,
      "PrincipalType": "sample string 2",
      "PrincipalStatus": "sample string 3",
      "Balance": 4.0,
      "TransactionDesc": "sample string 5",
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "Shortdescription": "sample string 7",
      "Issuing_Entity": "sample string 8",
      "Principal": "sample string 9",
      "Amount": 10.0,
      "StatusID": 11,
      "Included": true,
      "InitiallyIncluded": true,
      "CanBeSelected": true,
      "CanAggregate": true,
      "PrincipalStatusID": 1,
      "PrincipalTypeCategoryID": 1
    }
  ],
  "PrincipalFinancialHistorySummaryList": [
    {
      "PrincipalID": 1,
      "TransactionID": 2,
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "PrincipalDescription": "sample string 3",
      "Description": "sample string 4",
      "Debit": 1.0,
      "Credit": 1.0,
      "Balance": 1.0,
      "TransactionType": "sample string 5",
      "PrincipalComponentType": "sample string 6",
      "TransactionDisplayID": 7
    },
    {
      "PrincipalID": 1,
      "TransactionID": 2,
      "TransactionDate": "2025-09-02T23:07:11.1442806+00:00",
      "PrincipalDescription": "sample string 3",
      "Description": "sample string 4",
      "Debit": 1.0,
      "Credit": 1.0,
      "Balance": 1.0,
      "TransactionType": "sample string 5",
      "PrincipalComponentType": "sample string 6",
      "TransactionDisplayID": 7
    }
  ]
}

application/xml, text/xml

Sample:

<PrincipalFinancialHistoryVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.PrincipalFinancialHistory">
  <PrincipalFinancialHistorySummaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Principal">
    <d2p1:PrincipalFinancialHistorySummary>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:Credit>1</d2p1:Credit>
      <d2p1:Debit>1</d2p1:Debit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:PrincipalComponentType>sample string 6</d2p1:PrincipalComponentType>
      <d2p1:PrincipalDescription>sample string 3</d2p1:PrincipalDescription>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDisplayID>7</d2p1:TransactionDisplayID>
      <d2p1:TransactionID>2</d2p1:TransactionID>
      <d2p1:TransactionType>sample string 5</d2p1:TransactionType>
    </d2p1:PrincipalFinancialHistorySummary>
    <d2p1:PrincipalFinancialHistorySummary>
      <d2p1:Balance>1</d2p1:Balance>
      <d2p1:Credit>1</d2p1:Credit>
      <d2p1:Debit>1</d2p1:Debit>
      <d2p1:Description>sample string 4</d2p1:Description>
      <d2p1:PrincipalComponentType>sample string 6</d2p1:PrincipalComponentType>
      <d2p1:PrincipalDescription>sample string 3</d2p1:PrincipalDescription>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDisplayID>7</d2p1:TransactionDisplayID>
      <d2p1:TransactionID>2</d2p1:TransactionID>
      <d2p1:TransactionType>sample string 5</d2p1:TransactionType>
    </d2p1:PrincipalFinancialHistorySummary>
  </PrincipalFinancialHistorySummaryList>
  <PrincipalList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Principal">
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
    <d2p1:PrincipalSelectableVM>
      <d2p1:Amount>10</d2p1:Amount>
      <d2p1:Balance>4</d2p1:Balance>
      <d2p1:CanAggregate>true</d2p1:CanAggregate>
      <d2p1:CanBeSelected>true</d2p1:CanBeSelected>
      <d2p1:Included>true</d2p1:Included>
      <d2p1:InitiallyIncluded>true</d2p1:InitiallyIncluded>
      <d2p1:Issuing_Entity>sample string 8</d2p1:Issuing_Entity>
      <d2p1:Principal>sample string 9</d2p1:Principal>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalStatus>sample string 3</d2p1:PrincipalStatus>
      <d2p1:PrincipalStatusID>1</d2p1:PrincipalStatusID>
      <d2p1:PrincipalType>sample string 2</d2p1:PrincipalType>
      <d2p1:PrincipalTypeCategoryID>1</d2p1:PrincipalTypeCategoryID>
      <d2p1:Shortdescription>sample string 7</d2p1:Shortdescription>
      <d2p1:StatusID>11</d2p1:StatusID>
      <d2p1:TransactionDate>2025-09-02T23:07:11.1442806+00:00</d2p1:TransactionDate>
      <d2p1:TransactionDesc>sample string 5</d2p1:TransactionDesc>
    </d2p1:PrincipalSelectableVM>
  </PrincipalList>
</PrincipalFinancialHistoryVM>