Versions Compared

Key

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

Usage


Excerpt

Retrieves the total month collections based on individual Trust Accounts. 

It shows individual rows for the current month-to-date value and the previous month value. 

Info
title

Note:

Previously this call was named GetCurrentMonthCollections.


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


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

GetMonthlyCollections()

 

 

  • ​FacilityName

​String

​Name of the facility

  • ContractPrefix

String


  • ​FacilityAccountDescription

​String

  • ​TotalMonthCollections

​Decimal (10,2)

​The total collections for this month inclusive of tax

  • ​MonthStartDate

DateTime

​Date/time month commenced


Error Messages

Need info

Type

Error Code

Error Message

Error

02

Invalid user credentials

Info

00

Success

Related Pages

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


Panel

On this page:

Table of Contents