POST api/ArrangementScheduleDebtor/ArrangementScheduleGenerate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserContactID	integer	None.
AccountID	integer	None.
ArrangementAmount	decimal number	None.
FrequencyID	integer	None.
InstallmentAmount	decimal number	None.
StartDate	date	None.
LumpSumAmount	decimal number	None.
LumpSumDate	date	None.
BankTransactionMethodID	integer	None.
BankAccountID	integer	None.
PaymentTokenID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserContactID": 1,
  "AccountID": 1,
  "ArrangementAmount": 1.0,
  "FrequencyID": 1,
  "InstallmentAmount": 1.0,
  "StartDate": "2026-01-15T08:44:51.9983013+00:00",
  "LumpSumAmount": 1.0,
  "LumpSumDate": "2026-01-15T08:44:51.9983013+00:00",
  "BankTransactionMethodID": 1,
  "BankAccountID": 1,
  "PaymentTokenID": 1
}

application/xml, text/xml

Sample:

<ArrangementCreateScheduleParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ArrangementSchedule">
  <AccountID>1</AccountID>
  <ArrangementAmount>1</ArrangementAmount>
  <BankAccountID>1</BankAccountID>
  <BankTransactionMethodID>1</BankTransactionMethodID>
  <FrequencyID>1</FrequencyID>
  <InstallmentAmount>1</InstallmentAmount>
  <LumpSumAmount>1</LumpSumAmount>
  <LumpSumDate>2026-01-15T08:44:51.9983013+00:00</LumpSumDate>
  <PaymentTokenID>1</PaymentTokenID>
  <StartDate>2026-01-15T08:44:51.9983013+00:00</StartDate>
  <UserContactID>1</UserContactID>
</ArrangementCreateScheduleParams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArrangementScheduleListVM

Name	Type	Additional information
ArrangementScheduleList	Collection of ArrangementCreateSchedule	None.
ArrangementScheduleID	integer	None.
ArrangementID	integer	None.
ArrangementAmount	decimal number	None.
CommencementDate	date	None.
BankAccountID	integer	None.
BankTransactionMethodID	integer	None.
PaymentTokenID	integer	None.
IsReadOnly	boolean	None.
DaysTillComplete	integer	None.
DateTillComplete	string	None.
Response	IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "ArrangementScheduleList": [
    {
      "InstallmentAmount": 1.0,
      "TotalCost": 1.0,
      "TotalInterest": 1.0,
      "ArrangementBalance": 1.0,
      "ArrangementScheduleID": 1,
      "ArrangementID": 1,
      "PaymentMethod": "sample string 1",
      "BankAccount": "sample string 2",
      "CardNumber": "sample string 3",
      "InstallmentDue": "2026-01-15T08:44:51.9983013+00:00",
      "ArrangementTotalDueToDate": 1.0,
      "ArrangementInterestBearingBalance": 1.0,
      "InstallmentDueOld": "2026-01-15T08:44:51.9983013+00:00",
      "InstallmentAmountOld": 1.0,
      "Modified": true
    },
    {
      "InstallmentAmount": 1.0,
      "TotalCost": 1.0,
      "TotalInterest": 1.0,
      "ArrangementBalance": 1.0,
      "ArrangementScheduleID": 1,
      "ArrangementID": 1,
      "PaymentMethod": "sample string 1",
      "BankAccount": "sample string 2",
      "CardNumber": "sample string 3",
      "InstallmentDue": "2026-01-15T08:44:51.9983013+00:00",
      "ArrangementTotalDueToDate": 1.0,
      "ArrangementInterestBearingBalance": 1.0,
      "InstallmentDueOld": "2026-01-15T08:44:51.9983013+00:00",
      "InstallmentAmountOld": 1.0,
      "Modified": true
    }
  ],
  "ArrangementScheduleID": 1,
  "ArrangementID": 1,
  "ArrangementAmount": 1.0,
  "CommencementDate": "2026-01-15T08:44:51.9983013+00:00",
  "BankAccountID": 1,
  "BankTransactionMethodID": 1,
  "PaymentTokenID": 1,
  "IsReadOnly": true,
  "DaysTillComplete": 2,
  "DateTillComplete": "sample string 3",
  "Response": null
}

application/xml, text/xml

Sample:

<ArrangementScheduleListVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.ArrangementSchedule">
  <Response i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels" />
  <ArrangementAmount>1</ArrangementAmount>
  <ArrangementID>1</ArrangementID>
  <ArrangementScheduleID>1</ArrangementScheduleID>
  <ArrangementScheduleList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ArrangementSchedule">
    <d2p1:ArrangementCreateSchedule>
      <d2p1:ArrangementBalance>1</d2p1:ArrangementBalance>
      <d2p1:ArrangementID>1</d2p1:ArrangementID>
      <d2p1:ArrangementInterestBearingBalance>1</d2p1:ArrangementInterestBearingBalance>
      <d2p1:ArrangementScheduleID>1</d2p1:ArrangementScheduleID>
      <d2p1:ArrangementTotalDueToDate>1</d2p1:ArrangementTotalDueToDate>
      <d2p1:BankAccount>sample string 2</d2p1:BankAccount>
      <d2p1:CardNumber>sample string 3</d2p1:CardNumber>
      <d2p1:InstallmentAmount>1</d2p1:InstallmentAmount>
      <d2p1:InstallmentAmountOld>1</d2p1:InstallmentAmountOld>
      <d2p1:InstallmentDue>2026-01-15T08:44:51.9983013+00:00</d2p1:InstallmentDue>
      <d2p1:InstallmentDueOld>2026-01-15T08:44:51.9983013+00:00</d2p1:InstallmentDueOld>
      <d2p1:Modified>true</d2p1:Modified>
      <d2p1:PaymentMethod>sample string 1</d2p1:PaymentMethod>
      <d2p1:TotalCost>1</d2p1:TotalCost>
      <d2p1:TotalInterest>1</d2p1:TotalInterest>
    </d2p1:ArrangementCreateSchedule>
    <d2p1:ArrangementCreateSchedule>
      <d2p1:ArrangementBalance>1</d2p1:ArrangementBalance>
      <d2p1:ArrangementID>1</d2p1:ArrangementID>
      <d2p1:ArrangementInterestBearingBalance>1</d2p1:ArrangementInterestBearingBalance>
      <d2p1:ArrangementScheduleID>1</d2p1:ArrangementScheduleID>
      <d2p1:ArrangementTotalDueToDate>1</d2p1:ArrangementTotalDueToDate>
      <d2p1:BankAccount>sample string 2</d2p1:BankAccount>
      <d2p1:CardNumber>sample string 3</d2p1:CardNumber>
      <d2p1:InstallmentAmount>1</d2p1:InstallmentAmount>
      <d2p1:InstallmentAmountOld>1</d2p1:InstallmentAmountOld>
      <d2p1:InstallmentDue>2026-01-15T08:44:51.9983013+00:00</d2p1:InstallmentDue>
      <d2p1:InstallmentDueOld>2026-01-15T08:44:51.9983013+00:00</d2p1:InstallmentDueOld>
      <d2p1:Modified>true</d2p1:Modified>
      <d2p1:PaymentMethod>sample string 1</d2p1:PaymentMethod>
      <d2p1:TotalCost>1</d2p1:TotalCost>
      <d2p1:TotalInterest>1</d2p1:TotalInterest>
    </d2p1:ArrangementCreateSchedule>
  </ArrangementScheduleList>
  <BankAccountID>1</BankAccountID>
  <BankTransactionMethodID>1</BankTransactionMethodID>
  <CommencementDate>2026-01-15T08:44:51.9983013+00:00</CommencementDate>
  <DateTillComplete>sample string 3</DateTillComplete>
  <DaysTillComplete>2</DaysTillComplete>
  <IsReadOnly>true</IsReadOnly>
  <PaymentTokenID>1</PaymentTokenID>
</ArrangementScheduleListVM>