GET api/AllocationBreakdown/GetByPrincipalIDAndPaymentAmount?principalID={principalID}&paymentAmount={paymentAmount}

Request Information

URI Parameters

Name	Description	Type	Additional information
principalID		integer	Required
paymentAmount		decimal number	Required

Body Parameters

None.

Response Information

Resource Description

Collection of AllocationBreakdownItem

Name	Type	Additional information
AllocationBreakdownID	integer	None.
Allocated	decimal number	None.
AllocatedThisPayment	decimal number	None.
TotalRequired	decimal number	None.
PrincipalComponentID	integer	None.
PrincipalComponentTypeID	integer	None.
PrincipalComponentType	string	None.
PrincipalComponentPayeeDetailID	integer	None.
PayeeAccountID	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "AllocationBreakdownID": 1,
    "Allocated": 1.0,
    "AllocatedThisPayment": 2.0,
    "TotalRequired": 3.0,
    "PrincipalComponentID": 1,
    "PrincipalComponentTypeID": 1,
    "PrincipalComponentType": "sample string 4",
    "PrincipalComponentPayeeDetailID": 1,
    "PayeeAccountID": 1
  },
  {
    "AllocationBreakdownID": 1,
    "Allocated": 1.0,
    "AllocatedThisPayment": 2.0,
    "TotalRequired": 3.0,
    "PrincipalComponentID": 1,
    "PrincipalComponentTypeID": 1,
    "PrincipalComponentType": "sample string 4",
    "PrincipalComponentPayeeDetailID": 1,
    "PayeeAccountID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfAllocationBreakdownItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AllocationBreakdown">
  <AllocationBreakdownItem>
    <Allocated>1</Allocated>
    <AllocatedThisPayment>2</AllocatedThisPayment>
    <AllocationBreakdownID>1</AllocationBreakdownID>
    <PayeeAccountID>1</PayeeAccountID>
    <PrincipalComponentID>1</PrincipalComponentID>
    <PrincipalComponentPayeeDetailID>1</PrincipalComponentPayeeDetailID>
    <PrincipalComponentType>sample string 4</PrincipalComponentType>
    <PrincipalComponentTypeID>1</PrincipalComponentTypeID>
    <TotalRequired>3</TotalRequired>
  </AllocationBreakdownItem>
  <AllocationBreakdownItem>
    <Allocated>1</Allocated>
    <AllocatedThisPayment>2</AllocatedThisPayment>
    <AllocationBreakdownID>1</AllocationBreakdownID>
    <PayeeAccountID>1</PayeeAccountID>
    <PrincipalComponentID>1</PrincipalComponentID>
    <PrincipalComponentPayeeDetailID>1</PrincipalComponentPayeeDetailID>
    <PrincipalComponentType>sample string 4</PrincipalComponentType>
    <PrincipalComponentTypeID>1</PrincipalComponentTypeID>
    <TotalRequired>3</TotalRequired>
  </AllocationBreakdownItem>
</ArrayOfAllocationBreakdownItem>