Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Usage
Excerpt |
---|
Allows clients to retrieve the Calls calls history from the Debitsuccess billing system based on the specified parameters. |
Parameters
Name | Data Type | Length | Description | |
---|---|---|---|---|
DateCreated | Date/time message was processed | |||
User | ||||
| Unique ID for the user | |||
| String | Required | Provided by Debitsuccess | |
| String | Required | Provided by Debitsuccess | |
RequestInitiator | String | 100 | Optional | Optional – allows requesting user to be logged |
AccountReferenceNo | String | 15 | Optional* | Debitsuccess account reference |
ExternalAccountReferenceNo | String | 50 | Optional* | External account reference |
* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo
Response
Name | Data Type | Description |
---|---|---|
DateCreated | DateTime | Date/time message was processed |
Id | String | Unique ID for the message |
ResponseNotes () | Collection of validation messages | |
| String | |
| String | |
| Enum | Error, Warning, Info |
Status | Enum | Failed, Succeed, Unknown |
AccountReferenceNo | String | Debitsuccess Reference |
ExternalAccountReferenceNo | String | External account reference |
CallNotes () | ||
| String | Debitsuccess Reference |
| String | External account reference |
| String | Call Notes |
| String | CA (Call Attempt) CCI (CC Form In) CE (Client Enquiry) COM (Complaint) CR (Cancellation Request) CS (Customer Service) CU (Catch Up Arranged) DC (Detail Change) DDI (DD Form In) FAC (Facility Enquiry) FD (Final Credit Control Call) FDC (Final Credit Control Call Cancelation) FDD (Final Credit Control Call Deferral) FIR (First Payment Reversal) GTR (Guarantor Details Updated) HLD (Hold Refer To Author) LTR (Letter) OD (Overdue Call) OD1 (OD 1 Letter) OD2 (OD 2 Letter) OD3 (OD 3 Letter) ODM (OD Call Spoke to Member) ODP (OD Call Payment Made) ODS (OD Call Payment Scheduled) ODX (OD Call Left Message) PAY (Payment) PC (Payment Variation) RDC (Reinstated from Debt Collection) REE (Re Enrolment) REF (Refund Request) RTF (Reported To Facility) RTM (Returned Mail) RV (Review) SDC (Debt Collection) SUS (Suspension) SYS (System Update) TRN (Transfer) WCL (Welcome Letter) |
| String | Channel |
| DateTime | Call note date |
Error Code
Type | Error Code |
---|
Need info
Panel | |
---|---|
On this page:
|
Error Message | ||
---|---|---|
Error | 02 | Invalid user credentials |
Error | 12016 | Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both. |
Error | 08 | There is no record found with this criteria |
Error | 10 | Account is not active |
Error | 07 | Multiple accounts found with this criteria |
Info | 00 | Success |
Related Pages
Filter by label (Content by label) | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
Panel | |
---|---|
On this page:
|