Skip to main content

TransactionPosting - CFMS web service

This web service is used to post CFMS transactions and to get the status of a client's account.

  1. Post
  2. AccountStatus

Post Call

The Post call has four parameters:  systemCode,  userName,​  password,​ and  postTransactionItem.  The properties, dictionaries, and default values are listed for each parameter in the tables below.

Parameters with no Properties 

Parameter Property Value Accepted Notes
systemCode N/A Avatar System Code  
userName N/A Avatar User ID  
password N/A Avatar Password  

 

Parameters with Properties 

Parameter Property Value Accepted Notes

postTransactionItem

PATID

Free Text

The Client ID

 

AcctNumber

Free Text

Account number to post to.

 

TransDate

Date

Transaction date

 

TransCode

Dictionary #1385 in Client Funds Management File.

Transaction Code

 

Description

Free Text

 

  Amount Dollar amount  
  CheckNum Free text Check number (only used for debit transactions).
  ReceiptNum Free text Receipt number (only used for credit transactions).
  WithdrawalNum Free text Withdrawal number (only used for debit transactions).

Returned Values

Value Notes
Status '1' if successful, '0' if error encountered
Message Contains error message if 'Status' is '0'

AccountStatus Call

The AccountStatus call has five parameters:  systemCode,  userName,​  password,​ patid, and accountId.  The properties, dictionaries, and default values are listed for each parameter in the tables below.

Parameters with no Properties 

Parameter Property Value Accepted Notes
systemCode N/A Avatar System Code  
userName N/A Avatar User ID  
password N/A Avatar Password  
patid N/A Client Id  
accountId N/A account number  

 

Returned Values

Value Notes
Status '1' if successful, '0' if error encountered
Message Contains error message if 'Status' is '0'
AccountStatusCode either 'open' or 'closed'
AccountBalance Dollar amount.
AmountHardHold Dollar amount.
AvailableBalance Dollar amount.

 

  • Was this article helpful?