GET api/AllocationBreakdown/GetByPrincipalIDAndPaymentID?principalID={principalID}&paymentID={paymentID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| principalID | integer |
Required |
|
| paymentID | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
AllocationBreakdownVM| Name | Description | Type | Additional information |
|---|---|---|---|
| AllocationBreakdownItemList | Collection of AllocationBreakdownItem |
None. |
|
| PrincialID | integer |
None. |
|
| PaymentID | integer |
None. |
|
| AllocationID | integer |
None. |
|
| AdjustmentID | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"AllocationBreakdownItemList": [
{
"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
}
],
"PrincialID": 1,
"PaymentID": 1,
"AllocationID": 1,
"AdjustmentID": 1
}
application/xml, text/xml
Sample:
<AllocationBreakdownVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.AllocationBreakdown">
<AdjustmentID>1</AdjustmentID>
<AllocationBreakdownItemList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AllocationBreakdown">
<d2p1:AllocationBreakdownItem>
<d2p1:Allocated>1</d2p1:Allocated>
<d2p1:AllocatedThisPayment>2</d2p1:AllocatedThisPayment>
<d2p1:AllocationBreakdownID>1</d2p1:AllocationBreakdownID>
<d2p1:PayeeAccountID>1</d2p1:PayeeAccountID>
<d2p1:PrincipalComponentID>1</d2p1:PrincipalComponentID>
<d2p1:PrincipalComponentPayeeDetailID>1</d2p1:PrincipalComponentPayeeDetailID>
<d2p1:PrincipalComponentType>sample string 4</d2p1:PrincipalComponentType>
<d2p1:PrincipalComponentTypeID>1</d2p1:PrincipalComponentTypeID>
<d2p1:TotalRequired>3</d2p1:TotalRequired>
</d2p1:AllocationBreakdownItem>
<d2p1:AllocationBreakdownItem>
<d2p1:Allocated>1</d2p1:Allocated>
<d2p1:AllocatedThisPayment>2</d2p1:AllocatedThisPayment>
<d2p1:AllocationBreakdownID>1</d2p1:AllocationBreakdownID>
<d2p1:PayeeAccountID>1</d2p1:PayeeAccountID>
<d2p1:PrincipalComponentID>1</d2p1:PrincipalComponentID>
<d2p1:PrincipalComponentPayeeDetailID>1</d2p1:PrincipalComponentPayeeDetailID>
<d2p1:PrincipalComponentType>sample string 4</d2p1:PrincipalComponentType>
<d2p1:PrincipalComponentTypeID>1</d2p1:PrincipalComponentTypeID>
<d2p1:TotalRequired>3</d2p1:TotalRequired>
</d2p1:AllocationBreakdownItem>
</AllocationBreakdownItemList>
<AllocationID>1</AllocationID>
<PaymentID>1</PaymentID>
<PrincialID>1</PrincialID>
</AllocationBreakdownVM>