GET api/Principal/GetPrincipalForAllocationByTransactionDesc?transactionDesc={transactionDesc}&accountID={accountID}

Request Information

URI Parameters

Name	Description	Type	Additional information
transactionDesc		string	Required
accountID		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AllocationItem

Name	Type	Additional information
Type	string	None.
AllocationTypeID	integer	None.
Description	string	None.
CostID	integer	None.
MasterCostID	integer	None.
PrincipalID	integer	None.
InterestID	integer	None.
Date	date	None.
Total_Required	decimal number	None.
Allocated	decimal number	None.
Allocated_This_Payment	decimal number	None.
ToHost	boolean	None.
ExcludedFromManualAllocation	integer	None.
RemainingAfterThisPayment	decimal number	None.
Remaining	decimal number	None.
AllocatedPreviously	decimal number	None.
PrincipalTypeCategoryGroupID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Type": "sample string 1",
    "AllocationTypeID": 1,
    "Description": "sample string 2",
    "CostID": 1,
    "MasterCostID": 1,
    "PrincipalID": 1,
    "InterestID": 1,
    "Date": "2025-09-02T23:04:55.4498868+00:00",
    "Total_Required": 1.0,
    "Allocated": 1.0,
    "Allocated_This_Payment": 1.0,
    "ToHost": true,
    "ExcludedFromManualAllocation": 3,
    "RemainingAfterThisPayment": 1.0,
    "Remaining": 1.0,
    "AllocatedPreviously": 1.0,
    "PrincipalTypeCategoryGroupID": 1
  },
  {
    "Type": "sample string 1",
    "AllocationTypeID": 1,
    "Description": "sample string 2",
    "CostID": 1,
    "MasterCostID": 1,
    "PrincipalID": 1,
    "InterestID": 1,
    "Date": "2025-09-02T23:04:55.4498868+00:00",
    "Total_Required": 1.0,
    "Allocated": 1.0,
    "Allocated_This_Payment": 1.0,
    "ToHost": true,
    "ExcludedFromManualAllocation": 3,
    "RemainingAfterThisPayment": 1.0,
    "Remaining": 1.0,
    "AllocatedPreviously": 1.0,
    "PrincipalTypeCategoryGroupID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfAllocationItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Allocation">
  <AllocationItem>
    <Allocated>1</Allocated>
    <AllocatedPreviously>1</AllocatedPreviously>
    <Allocated_This_Payment>1</Allocated_This_Payment>
    <AllocationTypeID>1</AllocationTypeID>
    <CostID>1</CostID>
    <Date>2025-09-02T23:04:55.4498868+00:00</Date>
    <Description>sample string 2</Description>
    <ExcludedFromManualAllocation>3</ExcludedFromManualAllocation>
    <InterestID>1</InterestID>
    <MasterCostID>1</MasterCostID>
    <PrincipalID>1</PrincipalID>
    <PrincipalTypeCategoryGroupID>1</PrincipalTypeCategoryGroupID>
    <Remaining>1</Remaining>
    <RemainingAfterThisPayment>1</RemainingAfterThisPayment>
    <ToHost>true</ToHost>
    <Total_Required>1</Total_Required>
    <Type>sample string 1</Type>
  </AllocationItem>
  <AllocationItem>
    <Allocated>1</Allocated>
    <AllocatedPreviously>1</AllocatedPreviously>
    <Allocated_This_Payment>1</Allocated_This_Payment>
    <AllocationTypeID>1</AllocationTypeID>
    <CostID>1</CostID>
    <Date>2025-09-02T23:04:55.4498868+00:00</Date>
    <Description>sample string 2</Description>
    <ExcludedFromManualAllocation>3</ExcludedFromManualAllocation>
    <InterestID>1</InterestID>
    <MasterCostID>1</MasterCostID>
    <PrincipalID>1</PrincipalID>
    <PrincipalTypeCategoryGroupID>1</PrincipalTypeCategoryGroupID>
    <Remaining>1</Remaining>
    <RemainingAfterThisPayment>1</RemainingAfterThisPayment>
    <ToHost>true</ToHost>
    <Total_Required>1</Total_Required>
    <Type>sample string 1</Type>
  </AllocationItem>
</ArrayOfAllocationItem>