POST api/ArrangementClient/SaveArrangement
Request Information
URI Parameters
None.
Body Parameters
ArrangementSaveVM| Name | Description | Type | Additional information |
|---|---|---|---|
| Arrangement | ArrangementModel |
None. |
|
| ContactIds | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"Arrangement": {
"ArrangementID": 1,
"AccountID": 1,
"ArrangementAmount": 1.0,
"ArrangementDate": "2025-09-02T23:06:56.5438264+00:00",
"ArrangementTypeID": 1,
"LumpSumAmount": 1.0,
"LumpSumDueDate": "2025-09-02T23:06:56.5438264+00:00",
"InstallmentAmount": 1.0,
"PayDayOfMonth": 1,
"Pay_DayOfWeekID": 1,
"FrequencyID": 1,
"CommenceDate": "2025-09-02T23:06:56.5438264+00:00",
"NumberOfInstallmentPayments": 1,
"ArrangementEndDate": "2025-09-02T23:06:56.5438264+00:00",
"AccountBalanceAtArrangement": 1.0,
"LegalID": 1,
"BankAccountID": 1,
"ReminderDaysPrior": 1,
"AccountingBatchID": 1,
"LUPBroken": true,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:56.5438264+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:56.5438264+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:56.5438264+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"LUPTotalPayments": 1.0,
"ReviewDate": "2025-09-02T23:06:56.5438264+00:00",
"ArrangementSettlementTypeID": 1,
"BankTransactionMethodID": 1,
"LUPNextInstallmentDueDate": "2025-09-02T23:06:56.5438264+00:00",
"LUPFulfillDate": "2025-09-02T23:06:56.5438264+00:00",
"Description": "sample string 2",
"LoadID": 1,
"PaymentTokenID": 1,
"ArrangementStatusID": 1,
"LUPArrearsAmount": 1.0,
"Z_IDSTR": "sample string 3",
"LUPBrokenDate": "2025-09-02T23:06:56.5438264+00:00",
"LUPBrokenPartialAmount": 1.0,
"LUPNextInstallmentAmount": 1.0,
"LUPNoOfInstallmentsMade": 1,
"LUPNoOfInstallmentsRequired": 1,
"LUPNoOfInstallmentsRemaining": 1,
"Z_REF": "sample string 4",
"Z_REF2": "sample string 5",
"Z_REF3": "sample string 6",
"LUPNoOfDaysRequired": 1,
"LUPAccountStatusID": 1,
"LUPArrangementNoBreaks": 1,
"LUPNoOfAttemptsBeforeBreak": 1,
"LUPGraceDays": 1,
"OriginatingOfferID": 1,
"IsScheduleReissue": true,
"AccruingBalanceOptionID": 1,
"AccruingBalanceReissueFrequencyID": 1,
"LUPTotalDebtAtArrangement": 1.0,
"LUPPaymentBalance": 1.0,
"LUPArrangementBalance": 1.0,
"LUPArrangementAmountBasedOnDebtReferalStatus": 1.0,
"ConsentToAddDebtToPBI": true,
"ContactPaymentReferencesID": 1,
"IsExternalDeductionActive": true,
"CourtInstalmentOrder": true,
"FinancialHardship": true,
"FinancialHardshipDate": "2025-09-02T23:06:56.5438264+00:00",
"CourtInstalmentOrderDate": "2025-09-02T23:06:56.5438264+00:00",
"EmployerContactID": 1,
"IsAggregation": true,
"Original_ArrangementID": 1,
"ArrangementCategoryID": 1,
"VerifiedBy_ContactID": 1,
"VerifiedDebtorAdvisedByContactID": 1,
"SelectedEmailID": 1,
"SelectedPhoneNumberID": 1,
"SelectedAddressID": 1
},
"ContactIds": "sample string 1"
}
application/xml, text/xml
Sample:
<ArrangementSaveVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Arrangement">
<Arrangement xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Arrangement">
<d2p1:AccountBalanceAtArrangement>1</d2p1:AccountBalanceAtArrangement>
<d2p1:AccountID>1</d2p1:AccountID>
<d2p1:AccountingBatchID>1</d2p1:AccountingBatchID>
<d2p1:AccruingBalanceOptionID>1</d2p1:AccruingBalanceOptionID>
<d2p1:AccruingBalanceReissueFrequencyID>1</d2p1:AccruingBalanceReissueFrequencyID>
<d2p1:ArrangementAmount>1</d2p1:ArrangementAmount>
<d2p1:ArrangementCategoryID>1</d2p1:ArrangementCategoryID>
<d2p1:ArrangementDate>2025-09-02T23:06:56.5438264+00:00</d2p1:ArrangementDate>
<d2p1:ArrangementEndDate>2025-09-02T23:06:56.5438264+00:00</d2p1:ArrangementEndDate>
<d2p1:ArrangementID>1</d2p1:ArrangementID>
<d2p1:ArrangementSettlementTypeID>1</d2p1:ArrangementSettlementTypeID>
<d2p1:ArrangementStatusID>1</d2p1:ArrangementStatusID>
<d2p1:ArrangementTypeID>1</d2p1:ArrangementTypeID>
<d2p1:BankAccountID>1</d2p1:BankAccountID>
<d2p1:BankTransactionMethodID>1</d2p1:BankTransactionMethodID>
<d2p1:CommenceDate>2025-09-02T23:06:56.5438264+00:00</d2p1:CommenceDate>
<d2p1:ConsentToAddDebtToPBI>true</d2p1:ConsentToAddDebtToPBI>
<d2p1:ContactPaymentReferencesID>1</d2p1:ContactPaymentReferencesID>
<d2p1:CourtInstalmentOrder>true</d2p1:CourtInstalmentOrder>
<d2p1:CourtInstalmentOrderDate>2025-09-02T23:06:56.5438264+00:00</d2p1:CourtInstalmentOrderDate>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2025-09-02T23:06:56.5438264+00:00</d2p1:CreateTS>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:EmployerContactID>1</d2p1:EmployerContactID>
<d2p1:FinancialHardship>true</d2p1:FinancialHardship>
<d2p1:FinancialHardshipDate>2025-09-02T23:06:56.5438264+00:00</d2p1:FinancialHardshipDate>
<d2p1:FrequencyID>1</d2p1:FrequencyID>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2025-09-02T23:06:56.5438264+00:00</d2p1:InactiveTS>
<d2p1:InstallmentAmount>1</d2p1:InstallmentAmount>
<d2p1:IsAggregation>true</d2p1:IsAggregation>
<d2p1:IsExternalDeductionActive>true</d2p1:IsExternalDeductionActive>
<d2p1:IsScheduleReissue>true</d2p1:IsScheduleReissue>
<d2p1:LUPAccountStatusID>1</d2p1:LUPAccountStatusID>
<d2p1:LUPArrangementAmountBasedOnDebtReferalStatus>1</d2p1:LUPArrangementAmountBasedOnDebtReferalStatus>
<d2p1:LUPArrangementBalance>1</d2p1:LUPArrangementBalance>
<d2p1:LUPArrangementNoBreaks>1</d2p1:LUPArrangementNoBreaks>
<d2p1:LUPArrearsAmount>1</d2p1:LUPArrearsAmount>
<d2p1:LUPBroken>true</d2p1:LUPBroken>
<d2p1:LUPBrokenDate>2025-09-02T23:06:56.5438264+00:00</d2p1:LUPBrokenDate>
<d2p1:LUPBrokenPartialAmount>1</d2p1:LUPBrokenPartialAmount>
<d2p1:LUPFulfillDate>2025-09-02T23:06:56.5438264+00:00</d2p1:LUPFulfillDate>
<d2p1:LUPGraceDays>1</d2p1:LUPGraceDays>
<d2p1:LUPNextInstallmentAmount>1</d2p1:LUPNextInstallmentAmount>
<d2p1:LUPNextInstallmentDueDate>2025-09-02T23:06:56.5438264+00:00</d2p1:LUPNextInstallmentDueDate>
<d2p1:LUPNoOfAttemptsBeforeBreak>1</d2p1:LUPNoOfAttemptsBeforeBreak>
<d2p1:LUPNoOfDaysRequired>1</d2p1:LUPNoOfDaysRequired>
<d2p1:LUPNoOfInstallmentsMade>1</d2p1:LUPNoOfInstallmentsMade>
<d2p1:LUPNoOfInstallmentsRemaining>1</d2p1:LUPNoOfInstallmentsRemaining>
<d2p1:LUPNoOfInstallmentsRequired>1</d2p1:LUPNoOfInstallmentsRequired>
<d2p1:LUPPaymentBalance>1</d2p1:LUPPaymentBalance>
<d2p1:LUPTotalDebtAtArrangement>1</d2p1:LUPTotalDebtAtArrangement>
<d2p1:LUPTotalPayments>1</d2p1:LUPTotalPayments>
<d2p1:LegalID>1</d2p1:LegalID>
<d2p1:LoadID>1</d2p1:LoadID>
<d2p1:LumpSumAmount>1</d2p1:LumpSumAmount>
<d2p1:LumpSumDueDate>2025-09-02T23:06:56.5438264+00:00</d2p1:LumpSumDueDate>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2025-09-02T23:06:56.5438264+00:00</d2p1:ModifyTS>
<d2p1:NumberOfInstallmentPayments>1</d2p1:NumberOfInstallmentPayments>
<d2p1:Original_ArrangementID>1</d2p1:Original_ArrangementID>
<d2p1:OriginatingOfferID>1</d2p1:OriginatingOfferID>
<d2p1:PayDayOfMonth>1</d2p1:PayDayOfMonth>
<d2p1:Pay_DayOfWeekID>1</d2p1:Pay_DayOfWeekID>
<d2p1:PaymentTokenID>1</d2p1:PaymentTokenID>
<d2p1:ReminderDaysPrior>1</d2p1:ReminderDaysPrior>
<d2p1:ReviewDate>2025-09-02T23:06:56.5438264+00:00</d2p1:ReviewDate>
<d2p1:SelectedAddressID>1</d2p1:SelectedAddressID>
<d2p1:SelectedEmailID>1</d2p1:SelectedEmailID>
<d2p1:SelectedPhoneNumberID>1</d2p1:SelectedPhoneNumberID>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:VerifiedBy_ContactID>1</d2p1:VerifiedBy_ContactID>
<d2p1:VerifiedDebtorAdvisedByContactID>1</d2p1:VerifiedDebtorAdvisedByContactID>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
<d2p1:Z_IDSTR>sample string 3</d2p1:Z_IDSTR>
<d2p1:Z_REF>sample string 4</d2p1:Z_REF>
<d2p1:Z_REF2>sample string 5</d2p1:Z_REF2>
<d2p1:Z_REF3>sample string 6</d2p1:Z_REF3>
</Arrangement>
<ContactIds>sample string 1</ContactIds>
</ArrangementSaveVM>
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>