Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Usage


Excerpt

Deletes an unpaid penalty fee schedule on a customer’s account.


Info
title

Note

The deleted fees will be charged back to the facility.


Parameters

Name

Data Type

Length


Description

User





  • Username

String


Required

Provided by Debitsuccess

  • Password

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

PayScheduleId

Integer


Required

ScheduleId** to delete

* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo

** Obtained from GetCustomerAccountForDateRange or GetCustomerAccountByAccountId / GetCustomerAccountWithFeesByAccountID messages.

Response 

Name

Data Type

Description

DateCreated

DateTime

Date/time message was processed

Id

String

Unique ID for the message

ResponseNotes ()


Collection of validation messages

  • Code

String


  • Note

String


  • NoteType

Enum

Error, Warning, Info

Status

Enum

Failed, Succeed, Unknown

Error Messages

Type

Error Code

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

Error

13131

PaySchedule for given PayScheduleId not found

Error

14046

Invalid PaySchedule - you can only delete PenaltyFee schedule.

Error

14047

Cannot delete PenaltyFee that has been partially or fully paid.

Info

00

Success

Related Pages

Filter by label (Content by label)
showLabelsfalse
spacesDDE
showSpacefalse
sorttitle
typepage
cqllabel = "deletepenaltyfeeschedule" and type = "page" and space = "DDE" and ancestor = "986156090"
labelsdocumentation-space-sample


Panel

On this page:

Table of Contents


Panel
titleREST API

DELETE /wiki/spaces/DDE/pages/1729168052

OR

DELETE /wiki/spaces/DDE/pages/1255343223