Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Status | ||||||
|---|---|---|---|---|---|---|
|
Usage
| Excerpt |
|---|
Returns the schedule with payment status found in between the date range provided in the request. |
| Note |
|---|
Since this API call does not have pagination, our recommendation is to apply smaller date ranges (not more than 30 days) otherwise, you may receive timeout errors. |
Parameters
Name | Data Type | Length | Description | |
|---|---|---|---|---|
User | ||||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
RequestInitiator | String | 100 | Optional | Allows requesting user to be logged |
ContractPrefix | String | 6 | Optional | If not provided, records from all facility accounts associated with the WS user will be extracted |
Status | Enum | Optional |
For descriptions for of these statuses, see Statuses in Debitsuccess Systems. | |
StartDate | DateTime | Required | Start date and end date must be within 31 days | |
EndDate | DateTime | Optional | If EndDate is not provided, it will default to today date |
Response
Name | Data Type | Description |
|---|---|---|
DateCreated | Datetime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes() | ||
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Success, Unknown |
PaymentSchedule() | ||
| String(50) | Unique identifier |
| String(50) | |
| Number | Date of Status of Payment |
| String(15) | |
| Integer | |
| Datetime | |
| Datetime |
Error Messages
| Type | Error Code | Error Message |
|---|---|---|
| Error | 14033 | Invalid Start date - start date must be less than end date. |
| Error | 14101 | Invalid Start Date - start date must not be empty or in the future |
| Error | 14104 | Invalid Date range - start date and end date must be within 31 days. |
| Error | 13001 | Invalid Contract Prefix |
| Error | 100 | Invalid enum value ‘<invalid status>' cannot be deserialized into type 'Debitsuccess.WebServices.Core.DocketStatus'. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute. |
| Error | 100 | There was an error deserializing the object of type Debitsuccess.WebServices.Core.RequestMessages.RequestGetPaymentHistoryByStatusForDateRange. The value '' cannot be parsed as the type 'DateTime'. |
Related Pages
| Filter by label (Content by label) | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|