GET api/ApnMyArrangements/List?view={view}&from={from}&to={to}&scope={scope}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| view | string |
Default value is due |
|
| from | date |
None. |
|
| to | date |
None. |
|
| scope | string |
Default value is mine |
Body Parameters
None.
Response Information
Resource Description
ApiResultOfArrangementList| Name | Description | Type | Additional information |
|---|---|---|---|
| Response | ApiResponse |
None. |
|
| Data | ArrangementList |
None. |
Response Formats
application/json, text/json
Sample:
{
"Response": {
"Success": true,
"ErrorMessage": "sample string 2"
},
"Data": {
"View": "sample string 1",
"From": "2026-11-18T13:30:52.6221375+00:00",
"To": "2026-11-18T13:30:52.6221375+00:00",
"AllUsers": true,
"MaxRows": 3,
"Truncated": true,
"Items": [
{
"ArrangementScheduleID": 1,
"ArrangementID": 1,
"AccountID": 2,
"AccountNumber": "sample string 3",
"AccountName": "sample string 4",
"Entity": "sample string 5",
"InstallmentDue": "2026-11-18T13:30:52.6221375+00:00",
"InstallmentAmount": 1.0,
"IsPaid": true,
"AmountPaid": 1.0,
"ArrangementStatus": "sample string 7",
"ArrearsAmount": 1.0,
"IsBroken": true,
"BrokenDate": "2026-11-18T13:30:52.6221375+00:00",
"OwnerContactID": 1,
"OwnerName": "sample string 9"
},
{
"ArrangementScheduleID": 1,
"ArrangementID": 1,
"AccountID": 2,
"AccountNumber": "sample string 3",
"AccountName": "sample string 4",
"Entity": "sample string 5",
"InstallmentDue": "2026-11-18T13:30:52.6221375+00:00",
"InstallmentAmount": 1.0,
"IsPaid": true,
"AmountPaid": 1.0,
"ArrangementStatus": "sample string 7",
"ArrearsAmount": 1.0,
"IsBroken": true,
"BrokenDate": "2026-11-18T13:30:52.6221375+00:00",
"OwnerContactID": 1,
"OwnerName": "sample string 9"
}
]
}
}
application/xml, text/xml
Sample:
<ApiResultOfArrangementListoWZ9pqIS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
<Data>
<AllUsers>true</AllUsers>
<From>2026-11-18T13:30:52.6221375+00:00</From>
<Items>
<ArrangementListItem>
<AccountID>2</AccountID>
<AccountName>sample string 4</AccountName>
<AccountNumber>sample string 3</AccountNumber>
<AmountPaid>1</AmountPaid>
<ArrangementID>1</ArrangementID>
<ArrangementScheduleID>1</ArrangementScheduleID>
<ArrangementStatus>sample string 7</ArrangementStatus>
<ArrearsAmount>1</ArrearsAmount>
<BrokenDate>2026-11-18T13:30:52.6221375+00:00</BrokenDate>
<Entity>sample string 5</Entity>
<InstallmentAmount>1</InstallmentAmount>
<InstallmentDue>2026-11-18T13:30:52.6221375+00:00</InstallmentDue>
<IsBroken>true</IsBroken>
<IsPaid>true</IsPaid>
<OwnerContactID>1</OwnerContactID>
<OwnerName>sample string 9</OwnerName>
</ArrangementListItem>
<ArrangementListItem>
<AccountID>2</AccountID>
<AccountName>sample string 4</AccountName>
<AccountNumber>sample string 3</AccountNumber>
<AmountPaid>1</AmountPaid>
<ArrangementID>1</ArrangementID>
<ArrangementScheduleID>1</ArrangementScheduleID>
<ArrangementStatus>sample string 7</ArrangementStatus>
<ArrearsAmount>1</ArrearsAmount>
<BrokenDate>2026-11-18T13:30:52.6221375+00:00</BrokenDate>
<Entity>sample string 5</Entity>
<InstallmentAmount>1</InstallmentAmount>
<InstallmentDue>2026-11-18T13:30:52.6221375+00:00</InstallmentDue>
<IsBroken>true</IsBroken>
<IsPaid>true</IsPaid>
<OwnerContactID>1</OwnerContactID>
<OwnerName>sample string 9</OwnerName>
</ArrangementListItem>
</Items>
<MaxRows>3</MaxRows>
<To>2026-11-18T13:30:52.6221375+00:00</To>
<Truncated>true</Truncated>
<View>sample string 1</View>
</Data>
<Response>
<ErrorMessage>sample string 2</ErrorMessage>
<Success>true</Success>
</Response>
</ApiResultOfArrangementListoWZ9pqIS>