GET api/Adjustment/GetAllocation?accountID={accountID}&adjustmentAmount={adjustmentAmount}

Request Information

URI Parameters

Name	Description	Type	Additional information
accountID		integer	Required
adjustmentAmount		decimal number	Required

Body Parameters

None.

Response Information

Resource Description

AllocationVM

Name	Type	Additional information
AllocatedAmount	decimal number	None.
AllocatedThisPayment	decimal number	None.
PrincipalAllocatedAmount	decimal number	None.
CostAllocatedAmount	decimal number	None.
CostSpecificAllocatedAmount	decimal number	None.
InterestAllocatedAmount	decimal number	None.
OverPaymentAllocatedAmount	decimal number	None.
ToHostAllocatedAmount	decimal number	None.
AmountRemaining	decimal number	None.
IsAdjustment	boolean	None.
AllocationItemsList	Collection of AllocationItem	None.
AllocationBreakdownVM	Collection of AllocationBreakdownVM	None.

Response Formats

application/json, text/json

Sample:

{
  "AllocatedAmount": 1.0,
  "AllocatedThisPayment": 2.0,
  "PrincipalAllocatedAmount": 3.0,
  "CostAllocatedAmount": 4.0,
  "CostSpecificAllocatedAmount": 5.0,
  "InterestAllocatedAmount": 6.0,
  "OverPaymentAllocatedAmount": 7.0,
  "ToHostAllocatedAmount": 8.0,
  "AmountRemaining": 9.0,
  "IsAdjustment": true,
  "AllocationItemsList": [
    {
      "Type": "sample string 1",
      "AllocationTypeID": 1,
      "Description": "sample string 2",
      "CostID": 1,
      "MasterCostID": 1,
      "PrincipalID": 1,
      "InterestID": 1,
      "Date": "2025-09-02T23:07:12.9568682+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:07:12.9568682+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
    }
  ],
  "AllocationBreakdownVM": [
    {
      "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
    },
    {
      "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:

<AllocationVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Allocation">
  <AllocatedAmount>1</AllocatedAmount>
  <AllocatedThisPayment>2</AllocatedThisPayment>
  <AllocationBreakdownVM xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.AllocationBreakdown">
    <d2p1:AllocationBreakdownVM>
      <d2p1:AdjustmentID>1</d2p1:AdjustmentID>
      <d2p1:AllocationBreakdownItemList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AllocationBreakdown">
        <d4p1:AllocationBreakdownItem>
          <d4p1:Allocated>1</d4p1:Allocated>
          <d4p1:AllocatedThisPayment>2</d4p1:AllocatedThisPayment>
          <d4p1:AllocationBreakdownID>1</d4p1:AllocationBreakdownID>
          <d4p1:PayeeAccountID>1</d4p1:PayeeAccountID>
          <d4p1:PrincipalComponentID>1</d4p1:PrincipalComponentID>
          <d4p1:PrincipalComponentPayeeDetailID>1</d4p1:PrincipalComponentPayeeDetailID>
          <d4p1:PrincipalComponentType>sample string 4</d4p1:PrincipalComponentType>
          <d4p1:PrincipalComponentTypeID>1</d4p1:PrincipalComponentTypeID>
          <d4p1:TotalRequired>3</d4p1:TotalRequired>
        </d4p1:AllocationBreakdownItem>
        <d4p1:AllocationBreakdownItem>
          <d4p1:Allocated>1</d4p1:Allocated>
          <d4p1:AllocatedThisPayment>2</d4p1:AllocatedThisPayment>
          <d4p1:AllocationBreakdownID>1</d4p1:AllocationBreakdownID>
          <d4p1:PayeeAccountID>1</d4p1:PayeeAccountID>
          <d4p1:PrincipalComponentID>1</d4p1:PrincipalComponentID>
          <d4p1:PrincipalComponentPayeeDetailID>1</d4p1:PrincipalComponentPayeeDetailID>
          <d4p1:PrincipalComponentType>sample string 4</d4p1:PrincipalComponentType>
          <d4p1:PrincipalComponentTypeID>1</d4p1:PrincipalComponentTypeID>
          <d4p1:TotalRequired>3</d4p1:TotalRequired>
        </d4p1:AllocationBreakdownItem>
      </d2p1:AllocationBreakdownItemList>
      <d2p1:AllocationID>1</d2p1:AllocationID>
      <d2p1:PaymentID>1</d2p1:PaymentID>
      <d2p1:PrincialID>1</d2p1:PrincialID>
    </d2p1:AllocationBreakdownVM>
    <d2p1:AllocationBreakdownVM>
      <d2p1:AdjustmentID>1</d2p1:AdjustmentID>
      <d2p1:AllocationBreakdownItemList xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.AllocationBreakdown">
        <d4p1:AllocationBreakdownItem>
          <d4p1:Allocated>1</d4p1:Allocated>
          <d4p1:AllocatedThisPayment>2</d4p1:AllocatedThisPayment>
          <d4p1:AllocationBreakdownID>1</d4p1:AllocationBreakdownID>
          <d4p1:PayeeAccountID>1</d4p1:PayeeAccountID>
          <d4p1:PrincipalComponentID>1</d4p1:PrincipalComponentID>
          <d4p1:PrincipalComponentPayeeDetailID>1</d4p1:PrincipalComponentPayeeDetailID>
          <d4p1:PrincipalComponentType>sample string 4</d4p1:PrincipalComponentType>
          <d4p1:PrincipalComponentTypeID>1</d4p1:PrincipalComponentTypeID>
          <d4p1:TotalRequired>3</d4p1:TotalRequired>
        </d4p1:AllocationBreakdownItem>
        <d4p1:AllocationBreakdownItem>
          <d4p1:Allocated>1</d4p1:Allocated>
          <d4p1:AllocatedThisPayment>2</d4p1:AllocatedThisPayment>
          <d4p1:AllocationBreakdownID>1</d4p1:AllocationBreakdownID>
          <d4p1:PayeeAccountID>1</d4p1:PayeeAccountID>
          <d4p1:PrincipalComponentID>1</d4p1:PrincipalComponentID>
          <d4p1:PrincipalComponentPayeeDetailID>1</d4p1:PrincipalComponentPayeeDetailID>
          <d4p1:PrincipalComponentType>sample string 4</d4p1:PrincipalComponentType>
          <d4p1:PrincipalComponentTypeID>1</d4p1:PrincipalComponentTypeID>
          <d4p1:TotalRequired>3</d4p1:TotalRequired>
        </d4p1:AllocationBreakdownItem>
      </d2p1:AllocationBreakdownItemList>
      <d2p1:AllocationID>1</d2p1:AllocationID>
      <d2p1:PaymentID>1</d2p1:PaymentID>
      <d2p1:PrincialID>1</d2p1:PrincialID>
    </d2p1:AllocationBreakdownVM>
  </AllocationBreakdownVM>
  <AllocationItemsList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Allocation">
    <d2p1:AllocationItem>
      <d2p1:Allocated>1</d2p1:Allocated>
      <d2p1:AllocatedPreviously>1</d2p1:AllocatedPreviously>
      <d2p1:Allocated_This_Payment>1</d2p1:Allocated_This_Payment>
      <d2p1:AllocationTypeID>1</d2p1:AllocationTypeID>
      <d2p1:CostID>1</d2p1:CostID>
      <d2p1:Date>2025-09-02T23:07:12.9568682+00:00</d2p1:Date>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ExcludedFromManualAllocation>3</d2p1:ExcludedFromManualAllocation>
      <d2p1:InterestID>1</d2p1:InterestID>
      <d2p1:MasterCostID>1</d2p1:MasterCostID>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalTypeCategoryGroupID>1</d2p1:PrincipalTypeCategoryGroupID>
      <d2p1:Remaining>1</d2p1:Remaining>
      <d2p1:RemainingAfterThisPayment>1</d2p1:RemainingAfterThisPayment>
      <d2p1:ToHost>true</d2p1:ToHost>
      <d2p1:Total_Required>1</d2p1:Total_Required>
      <d2p1:Type>sample string 1</d2p1:Type>
    </d2p1:AllocationItem>
    <d2p1:AllocationItem>
      <d2p1:Allocated>1</d2p1:Allocated>
      <d2p1:AllocatedPreviously>1</d2p1:AllocatedPreviously>
      <d2p1:Allocated_This_Payment>1</d2p1:Allocated_This_Payment>
      <d2p1:AllocationTypeID>1</d2p1:AllocationTypeID>
      <d2p1:CostID>1</d2p1:CostID>
      <d2p1:Date>2025-09-02T23:07:12.9568682+00:00</d2p1:Date>
      <d2p1:Description>sample string 2</d2p1:Description>
      <d2p1:ExcludedFromManualAllocation>3</d2p1:ExcludedFromManualAllocation>
      <d2p1:InterestID>1</d2p1:InterestID>
      <d2p1:MasterCostID>1</d2p1:MasterCostID>
      <d2p1:PrincipalID>1</d2p1:PrincipalID>
      <d2p1:PrincipalTypeCategoryGroupID>1</d2p1:PrincipalTypeCategoryGroupID>
      <d2p1:Remaining>1</d2p1:Remaining>
      <d2p1:RemainingAfterThisPayment>1</d2p1:RemainingAfterThisPayment>
      <d2p1:ToHost>true</d2p1:ToHost>
      <d2p1:Total_Required>1</d2p1:Total_Required>
      <d2p1:Type>sample string 1</d2p1:Type>
    </d2p1:AllocationItem>
  </AllocationItemsList>
  <AmountRemaining>9</AmountRemaining>
  <CostAllocatedAmount>4</CostAllocatedAmount>
  <CostSpecificAllocatedAmount>5</CostSpecificAllocatedAmount>
  <InterestAllocatedAmount>6</InterestAllocatedAmount>
  <IsAdjustment>true</IsAdjustment>
  <OverPaymentAllocatedAmount>7</OverPaymentAllocatedAmount>
  <PrincipalAllocatedAmount>3</PrincipalAllocatedAmount>
  <ToHostAllocatedAmount>8</ToHostAllocatedAmount>
</AllocationVM>