POST api/ArrangementDebtor/RequestArrangement

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccountId	integer	None.
ContactId	integer	None.
ArrangementAmount	decimal number	None.
PrincipalIds	string	None.
PaymentOption	RequestArrangementDebtorOption	None.
FullPayment	FullPaymentModel	None.
Centrelink	CentrelinkModel	None.
ManualPayment	ManualPaymentModel	None.
DirectDebit	DirectDebitModel	None.
IsAggregation	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountId": 1,
  "ContactId": 1,
  "ArrangementAmount": 1.0,
  "PrincipalIds": "sample string 2",
  "PaymentOption": 1,
  "FullPayment": {
    "PaymentDate": "2025-09-02T23:07:11.6656917+00:00",
    "FrequencyID": 1,
    "ArrangementTypeID": 1
  },
  "Centrelink": {
    "PaymentStartDate": "2025-09-02T23:07:11.6656917+00:00",
    "InstalmentAmount": 1.0,
    "CustomerRefNumber": "sample string 1",
    "BenefitType": 1,
    "FrequencyID": 1,
    "ArrangementTypeID": 1
  },
  "ManualPayment": {
    "PaymentFrequency": 1,
    "InstalmentAmount": 1.0,
    "PaymentStartDate": "2025-09-02T23:07:11.6757044+00:00",
    "ArrangementTypeID": 1
  },
  "DirectDebit": {
    "PaymentFrequency": 1,
    "BsbNumber": "sample string 1",
    "AccountNumber": "sample string 2",
    "AccountTitle": "sample string 3",
    "InstalmentAmount": 1.0,
    "PaymentStartDate": "2025-09-02T23:07:11.6757044+00:00",
    "ArrangementTypeID": 1,
    "BankTransactionMethodID": 1
  },
  "IsAggregation": true
}

application/xml, text/xml

Sample:

<RequestArrangementDebtorVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Arrangement">
  <AccountId>1</AccountId>
  <ArrangementAmount>1</ArrangementAmount>
  <Centrelink>
    <ArrangementTypeID>1</ArrangementTypeID>
    <BenefitType>1</BenefitType>
    <CustomerRefNumber>sample string 1</CustomerRefNumber>
    <FrequencyID>1</FrequencyID>
    <InstalmentAmount>1</InstalmentAmount>
    <PaymentStartDate>2025-09-02T23:07:11.6656917+00:00</PaymentStartDate>
  </Centrelink>
  <ContactId>1</ContactId>
  <DirectDebit>
    <AccountNumber>sample string 2</AccountNumber>
    <AccountTitle>sample string 3</AccountTitle>
    <ArrangementTypeID>1</ArrangementTypeID>
    <BankTransactionMethodID>1</BankTransactionMethodID>
    <BsbNumber>sample string 1</BsbNumber>
    <InstalmentAmount>1</InstalmentAmount>
    <PaymentFrequency>1</PaymentFrequency>
    <PaymentStartDate>2025-09-02T23:07:11.6757044+00:00</PaymentStartDate>
  </DirectDebit>
  <FullPayment>
    <ArrangementTypeID>1</ArrangementTypeID>
    <FrequencyID>1</FrequencyID>
    <PaymentDate>2025-09-02T23:07:11.6656917+00:00</PaymentDate>
  </FullPayment>
  <IsAggregation>true</IsAggregation>
  <ManualPayment>
    <ArrangementTypeID>1</ArrangementTypeID>
    <InstalmentAmount>1</InstalmentAmount>
    <PaymentFrequency>1</PaymentFrequency>
    <PaymentStartDate>2025-09-02T23:07:11.6757044+00:00</PaymentStartDate>
  </ManualPayment>
  <PaymentOption>FullPayment28Days</PaymentOption>
  <PrincipalIds>sample string 2</PrincipalIds>
</RequestArrangementDebtorVM>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActionResultVM

Name	Description	Type	Additional information
Response		IResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": null
}

application/xml, text/xml

Sample:

<ActionResultVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels">
  <Response i:nil="true" />
</ActionResultVM>