Last Update: February 2, 2021

DDAS FUNCTIONS

Click the DDAS functions to view conditions, parameters, examples, and notes.

Function	CONTACTSEEK
Description	Lookup a specific dname record to be used in custom fields, and DDAS.
Condition	contactseek('type','dbr','field')
Parameters	type = dname.type
	num = dname.dbr
	field = dname field to query
Example(s)	contactseek('DEB','1','FILEAS')
	contactseek('FIN','2','COMPANY')
Notes	Only supported in DDAS (except SYSTEM.NEWCASE) and Word merge fields.

Lookup a specific dname record to be used in custom fields, and DDAS.

Function	GETPAIDBUCKET
Description	Returns the paid buckets from trans.
Condition	GETPAIDBUCKET(value, 'bucket', 'period', 'rettype', 'datefield')
Parameters	value = ourfile (debt.ourfile)
	Bucket = trans paid buckets (PRINPAID, INTPAID, COSTPAID, ACHARGEPD, AFEEPAID)
	Period = MTD (month to date), YTD (Year to date), TTD (total to date)
	Rettype = N - Number, C - Character
	datefield - TRXDATE or PAYDATE (optional - will default to TRXDATE if not entered)
Examples	ALLTRIM(STR(GETPAIDBUCKET(debt.ourfile, 'PRINPAID', 'YTD', 'N'),12,2)),
	ALLTRIM(STR(GETPAIDBUCKET(debt.ourfile, 'PRINPAID', 'YTD', 'N', 'PAYDATE'),12,2))
Notes	Should use ALLTRIM and STR functions with function.

Returns the paid buckets from trans.

Function	GETTASK
Description	Returns the information for a specific task on an ourfile.
Condition	gettask('name', 'condition', 'active')
Parameters	name = Task code name (deadline.code)
	condition = Select statement for fields to return from deadline
	active = (optional) .f. will return ACTIVE task info, .t. will return COMPLETED task info
Example(s)	GETTASK("TEST", "dtoc(deadline.date) + ' - ' + alltrim(deadline.descr)")
	GETTASK("TEST", "dtoc(deadline.date) + ' - ' + alltrim(deadline.descr)", .t.)
	GETTASK("TEST", "dtoc(deadline.date) + ' - ' + alltrim(deadline.descr)", .f.)
Notes	Only supported in Word merge.

Returns the information for a specific task on an ourfile.

Function	DLEGALSEEK
Description	Lookup a specific dlegal record to be used in custom fields, reports and query, and DDAS.
Condition	dlegalseek(value, 'code', 'field')
Parameters	value = ourfile (debt.ourfile)
	code = dlegal.code
	field = dlegal field to query
Example(s)	dlegalseek(debt.ourfile,'1','defendant')
	dlegalseek(debt.ourfile,'2','caseno')
Notes	n/a

Lookup a specific dlegal record to be used in custom fields, reports and query, and DDAS.

Function	GETPAYADJ
Description	Returns the sum of adjustments from paycard.
Condition	getpayadj(value, 'type')
Parameters	value = ourfile(debt.ourfile)
	type = paycard adjustment type(P, J, S = Principal, R, M, C, F)
Example(s)	GETPAYADJ(debt.ourfile, 'J')
	ALLTRIM(STR(GETPAYADJ(debt.ourfile, 'M')12,2))
Notes	Only supported in Word merge. Should use ALLTRIM and STR functions with command.

Returns the sum of adjustments from paycard.

Function	GETTRANS
Description	Returns trans value from most recent trans trx record indicated.
Condition	GETTRANS(value, 'trx', 'field')
Parameters	value = ourfile(debt.ourfile)
	trx = trans trx record to query (trans.trx)
	field = trans field to query
Example(s)	GETTRANS(debt.ourfile, '01', 'trans.cdesc')
	ALLTRIM(STR(GETTRANS(debt.ourfile, '17', 'trans.cash'),12,2))
	DTOC(GETTRANS(debt.ourfile, '01', 'trans.trxdate'))
	PADR(GETTRANS(debt.ourfile, '01', 'trans.cdesc'),50)
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns trans value from most recent trans trx record indicated.

Function	DOC1EXPORT
Description	DDAS program to pull documents from an ourfile and save in desired location.
Condition	doc1export with value,'dbr', 'command', 'location', 'filename', 'success', 'fail'
Parameters	value = ourfile (debt.ourfile or dfile)
	dbr = debtor number
	command = selection statement for documents to pull
	location = save location for documents
	success = task code to add if export is successful
	fail = task code to add if export is not successful
Example(s)	doc1export with dfile, "1", "inlist(doctype, 'AFF')", ".\import\abclegal\upload\docs\", 'alltrim(dfile) + "_" + mdbr + "_" + alltrim(mdocid)', "ABC_DOCS", "ABC_ERROR"
Notes	Only supported in DDAS. Do NOT put "DO" before doc1export in the command box in DDAS.

DDAS program to pull documents from an ourfile and save in desired location.

Function	GETPAYCARD
Description	Returns the most recent paycard value.
Condition	getpaycard('type',num,'field')
Parameters	type = paycard type (P,I,M,C)
	num = record number to return (1 = most recent, 2 = 2nd most recent, etc)
	field = paycard fields to return
Example(s)	GETPAYMENT('P',1,'alltrim(str(paycard.amount,12,2))')
	GETPAYMENT('P',1,'alltrim(paycard.comment) + ': ' + alltrim(str(paycard.amount,12,2))')
	GETPAYMENT('C',2,'alltrim(paycard.comment) + ': ' + alltrim(str(paycard.amount,12,2))')
Notes	Only supported in Word Merge. For Numbers, use alltrim(Str(number,12,2)) - only around numeric field.

Returns the most recent paycard value.

Function	GETXNOTE
Description	Returns the most recent x type note from the status table on an ourfile (Status.statusnote).
Condition	GETXNOTE(value)
Parameters	value = ourfile (debt.ourfile)
Example(s)	GETXNOTE(debt.ourfile)
Notes	n/a

Returns the most recent x type note from the status table on an ourfile (Status.statusnote).

Function	GETCOMPBUCKET
Description	Returns balance of all active - not closed creditor compfiles.
Condition	GETCOMPBUCKET(value, 'amount')
Parameters	value = ourfile (debt.ourfile)
	bucket = balance bucket to return (PRINCIP, INTEREST, ATTFEE, COST, ACHARGE, BALANCE, NUMFILES, TOTALPAID)
Example(s)	GETCOMPBUCKET(debt.ourfile, 'PRINCIP')
	ALLTRIM(STR(GETCOMPBUCKET(debt.ourfile, 'ATTFEE'),12,2))
	ALLTRIM(STR(GETCOMPBUCKET(debt.ourfile, 'INTEREST'),12,2))
Notes	Only supported in Word Merge or DDAS. Should use ALLTRIM and STR functions with command.

Returns balance of all active – not closed creditor compfiles.

Function	GETPAYEFT
Description	Returns values from the payeft table.
Condition	GETPAYEFT(value, 'field', 'approved', 'payment', 'date', 'complete', 'dbr')
Parameters	value = ourfile (debt.ourfile)
	field = payeft field to pull
	approved= System looks to see if payments are approved for processing. True by default, False will pull all files regardless of approved status.
	payments = This is how many payments after the first payment the system finds. By default it'll grab the first payment it finds, but if you need 2 payments into the future, it'll do that.
	date = By default, it will find the first payment due today or later. If this is populated, it will look for items set to run after this date.
	complete = System looks for unprocessed items by default.
	dbr = dbr num in quotes as: '1' or '2' or '3'
Example(s)	GETPAYEFT(debt.ourfile, 'totamount','F', '1', date(), 'F', '1')
	GETPAYEFT(debt.ourfile, 'totamount','F', '1', date(), 'F', '1')
	GETPAYEFT(debt.ourfile, 'totamount','F', '1', date(), 'F', '1')
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns values from the payeft table.

Function	HISTTOTALS
Description	Query paid buckets from paycardh.dbf
Condition	HISTTOTALS(value, 'type', date)
Parameters	value = ourfile (debt.ourfile)
	type = field in paycardh to sum (see notes column)
	date = date field to calculate payments from (Do not enclose in quotes)
Example(s)	HISTTOTALS(debt.ourfile,'PAYTOTAL', debt.assdate)
	HISTTOTALS(dfile,'PRINPAID', dlegal.judgdate)
Notes	TYPES:
	Payments -'PAYTOTAL'
	Interest accruals-'INTACCRUAL'
	Cost accruals-'COSTACCRUAL'
	Princip accruals-'PRINACCRUAL'
	Attfee accruals-'AFEEACCRUAL'
	Miscfee accruals-'MFEEACCRUAL'
	Interest paid-'INTPAID'
	Cost paid-'COSTPAID'
	Princip paid-'PRINPAID'
	Attfee paid-'AFEEPAID'
	Miscfee paid-'MFEEPAID'

Query paid buckets from paycardh.dbf.

Function	GETCOMPPAY
Description	Returns the sum of the paycard types specified for an account.
Condition	GETCOMPPAY(value, 'adj')
Parameters	value = ourfile (debt.ourfile)
	adj = paycard type (paycard.payadj): P, C, N, J
Example(s)	ALLTRIM(STR(GETCOMPPAYADJ(debt.ourfile, 'N'),12,2))
	ALLTRIM(STR(GETCOMPPAYADJ(debt.ourfile, 'C'),12,2))
Notes	Only supported in Word Merge. Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)).

Returns the sum of the paycard types specified for an account.

Function	GETPAYMISC
Description	Returns the first occurance of from paycard depending on type.
Condition	GETPAYMISC(value, 'type', 'keyword', 'field')
Parameters	value = ourfile (debt.ourfile)
	type = adjustment types (P,I,M,C,F, etc)
	keyword = FIRST word in adjustment description field (must be first word)
	field = fields to pull from paycard
Example(s)	GETPAYMISC(debt.ourfile, "F","ATTORNEY","alltrim(paycard.comment) + ': ' + alltrim(str(paycard.amount,12,2))")
	GETPAYMISC(debt.ourfile, "M","DAMAGES","alltrim(str(paycard.amount,12,2))")
Notes	Only supported in Word merge. Should use ALLTRIM and STR functions with command.

Returns the first occurance of from paycard depending on type.

Function	IFDOCS
Description	Returns a true or false based on if a document exists in scanfile.
Condition	IFDOCS(value, 'field', 'check')
Parameters	value = ourfile(debt.ourfile)
	field = scanfile field to check (DOCTYPE, DOCTITLE, FOLDER)
	check = value to search for in field
Example(s)	IFDOCS(debt.ourfile,'DOCTYPE', 'B15')
	IFDOCS(debt.ourfile,'FOLDER', '0ATEST')
	IFDOCS(debt.ourfile,'DOCTITLE', 'PJRoggs')
Notes	Mainly used in DDAS.

Returns a true or false based on if a document exists in scanfile.

Function	GETCOST (R&Q)
Description	Get totals of certain cost based on cost codes used and date range from R&Q.
Condition	getcost('type', 'condition1', date, 'condition2', value)
Parameters	type = COSTCODE or COSTDESC
	condition1 = Select statement for cost table
	date = Pulls cost amounts after/= date (format = {^YYYY/MM/DD}). If blank, all records
	condition2 = select statement for paycardh table
	value = ourfile (debt.ourfile)
Example(s)	GETCOST("COSTCODE",'inlist(costcode, "50", "51", "68", "77")', { / / },'', debt.ourfile)
	GETCOST("COSTDESC",'("SERVICE" $ upper(descr) or "SUIT FILED" $ upper(descr))', { / / },'', debt.ourfile)
	GETCOST("COSTCODE",'inlist(costcode, "50", "51", "68", "77")', {^2018/01/01},'', debt.ourfile)
	GETCOST("COSTDESC",'("SERVICE" $ upper(descr) or "SUIT FILED" $ upper(descr))', {^2018/01/01},'inlist(payadj, "P")', debt.ourfile)
Notes	To use in R&Q, all parameters must be set.

Get totals of certain cost based on cost codes used and date range from R&Q.

Function	GETPBUCKET
Description	Retuns the sum of the amounts from paycard.
Condition	GETPBUCKET(value, 'AMOUNT', 'period', 'char')
Parameters	value = ourfile (debt.ourfile)
	amount = always 'AMOUNT'
	period = MTD (month to date), YTD(year to date), TTD (total to date)
	char = 'N' for Numeric, 'C' for Character
Example(s)	GETPBUCKET(DEBT.OURFILE, 'AMOUNT','MTD','C')
	ALLTRIM(STR(GETPBUCKET(DEBT.OURFILE, 'AMOUNT','YTD','N'),12,2))
Notes	Only supported in Word merge. Should use ALLTRIM and STR functions with command.

Retuns the sum of the amounts from paycard.

Function	IFTAGS
Description	Returns a true or false based on if a tag is on an ourfile.
Condition	IFTAGS(value, 'dbr', 'tag')
Parameters	value = ourfile(debt.ourfile)
	dbr = dbr number assigned to tag (if assigned, can be blank)
	tag = tag code on ourfile (tags.tag)
Example(s)	IFTAG(debt.ourfile, ' ', 'HOLD')
	IFTAG(debt.ourfile, '1', 'COMPLAINT')
Notes	Mainly used in DDAS.

Returns a true or false based on if a tag is on an ourfile.

Function	GETCOST (WORD MERGE/ DDAS)
Description	Get totals of certain cost based on cost codes used and date range in custom fields.
Condition	getcost('type', 'condition1', date, 'condition2', value)
Parameters	type = COSTCODE or COSTDESC
	condition1 = Select statement for cost table
	date = Pulls cost amounts after/= date (format = {^YYYY/MM/DD}). If blank, all records
	condition2 = select statement for paycardh table
	value = ourfile (debt.ourfile)
Example(s)	GETCOST("COSTCODE",'inlist(costcode, "50", "51", "68", "77")', {^2018/01/01})
	GETCOST("COSTDESC",'("SERVICE" $ upper(descr) or "SUIT FILED" $ upper(descr))', {^2018/01/01})
Notes	For Word merge and DDAS, the last two parameters are not required.

Get totals of certain cost based on cost codes used and date range in custom fields.

Function	GETPCOMPPAY
Description	Returns the sum of payments (paycard.payadj = 'P') made between complaint date (dlegal.compdate) and judgment date (dlegal.judgdate).
Condition	GETPCOMPPAY(value)
Parameters	value = ourfile(debt.ourfile)
Example(s)	GETPCOMPPAY(debt.ourfile)
	ALLTRIM(STR(GETPCOMPPAY(debt.ourfile),12,2))
Notes	Should use ALLTRIM and STR functions with command in Word merge.

Returns the sum of payments (paycard.payadj = ‘P’) made between complaint date (dlegal.compdate) and judgment date (dlegal.judgdate).

Function	IFTASK
Description	Checks to see if a task in on an ourfile (active or completed).
Condition	IFTASK(value, 'task', 'comp')
Parameters	value = ourfile (debt.ourfile)
	task = task code name (deadline.code)
	comp = completed status (T for complete, F for incomplete)
Example(s)	IFTASK(debt.ourfile, 'TASK1')
	IFTASK(debt.ourfile, 'TASK1','T')
	IFTASK(debt.ourfile, 'TASK1','F')
Notes	Mainly used in DDAS.

Checks to see if a task in on an ourfile (active or completed).

Function	GETCOSTCODEAMT
Description	Pulls the amount of the cost code from the cost code matrix.
Condition	GETCOSTCODEAMT('code', value)
Parameters	code = cost code to query
	value = ourfile (debt.ourfile)
Example(s)	GETCOSTCODEAMT('50', debt.ourfile)
	STR(GETCOSTCODEAMT('50', debt.ourfile),12,2)
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Pulls the amount of the cost code from the cost code matrix.

Function	GETPSUITPAY
Description	Returns the sum of payments (paycard.payadj = 'P') made between suit date (dlegal.suitdate) and judgment date (dlegal.judgdate).
Condition	GETPSUITPAY(value)
Parameters	value = ourfile(debt.ourfile)
Example(s)	GETPSUITPAY(debt.ourfile)
	ALLTRIM(STR(GETPSUITPAY(debt.ourfile),12,2))
Notes	Should use ALLTRIM and STR functions with command in Word merge.

Returns the sum of payments (paycard.payadj = ‘P’) made between suit date (dlegal.suitdate) and judgment date (dlegal.judgdate).

Function	IFTASKDATE
Description	Returns the most recent task completed date for the designated task.
Condition	IFTASKDATE(value, 'task')
Parameters	value = ourfile (debt.ourfile)
	task = task code name (deadline.code)
Example(s)	IFTASKDATE(debt.ourfile, 'TEST1')
Notes	n/a

Returns the most recent task completed date for the designated task.

Function	GETCOSTPJ
Description	Get pre or post judgment cost totals from paycard.
Condition	getcostpj(value, 'type', type2')
Parameters	value = ourfile (debt.ourfile)
	type = 'PREJ' for pre-judgment costs, 'POSTJ' for post judgment costs
	type2 = 'INCLPAYCARDH' to include paycardh costs (payadj = 'C')
Example(s)	GETCOSTPJ(debt.ourfile, 'PREJ')
	GETCOSTPJ(debt.ourfile, 'PREJ', 'INCLPAYCARDH')
	GETCOSTPJ(debt.ourfile, 'POSTJ')
	STR(GETCOSTPJ(debt.ourfile, 'PREJ'),12,2)
Notes	Returns a number as a numeric field (will round to nearest dollar). Use Str(getcostpj(debt.ourfile, 'PREJ'),12,2) to return as character (result without rounding).

Get pre or post judgment cost totals from paycard.

Function	GETPTP
Description	Returns ptp field from caseptp.
Condition	getptp(value, 'dbr', 'fieldname')
Parameters	value = ourfile (debt.ourfile)
	dbr = caseptp dbr value (borrower 1, 2, 3, etc)
	fieldname = caseptp field to query
Example(s)	GETPTP(debt.ourfile, '2', 'CASEPTP.PAYSTATUS')
	ALLTRIM(STR(GETPTP(debt.ourfile, '1', 'CASEPTP.TOTEXPECT'),12,2))
	DTOC(GETTPTP(debt.ourfile, '2', 'CASEPTP.DUEDATE'))
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns ptp field from caseptp.

Function	IFTASKDUE
Description	Returns the most recent due date for a designated task.
Condition	IFTASKDUE(value, 'task')
Parameters	value = ourfile (debt.ourfile)
	task = task code name (deadline.code)
Example(s)	IFTASKDUE(debt.ourfile, 'TEST1')
Notes	If using in R&Q, use PADR command to set field length.

Returns the most recent due date for a designated task.

Function	GETCOSTPREJ
Description	Query pre-judgment costs on an ourfile (cost.chgdebt = 'J')
Condition	GETCOSTPREJ('Type', 'condition', 'date', 'hist')
Parameters	type = 'COSTCODE' or 'COSTDESC'
	condition = search condition for either codecode or costdesc
	date = first date in cost.dbf to calculate from. If Blank, calculates all records
	hist = (optional) list of codes to check in cost in paycardh, inlist(adjcode, "WFO ", "FF ")
Example(s)	GETCOSTPREJ("COSTCODE",'inlist(costcode,"51","52")'," )
	GETCOSTPREJ('COSTDESC','("ALIAS SUMMONS" $ upper(descr) or "SUIT FILED" $ upper(descr))' ," )
	GETCOSTPREJ('COSTDESC','("ALIAS SUMMONS" $ upper(descr) or "SUIT FILED" $ upper(descr))' ,{^01/01/2017})
Notes	Does NOT require Alltrim(str() - will automaticall pull amount.

Query pre-judgment costs on an ourfile (cost.chgdebt = ‘J’).

Function	GETPTPPAY
Description	Returns the sum of payments (paycard.payadj = 'P') made on an active PTP between ptp create date (caseptp.date) and date run.
Condition	GETPTPPAY(value, 'dbr')
Parameters	value = ourfile(debt.ourfile)
	dbr = caseptp dbr value (borrower 1, 2, 3, etc)
Example(s)	GETPTPPAY(debt.ourfile, '1')
	ALLTRIM(STR(GETPTPPAY(debt.ourfile, '2'),12,2))
Notes	Should use ALLTRIM and STR functions with command in Word merge.

Returns the sum of payments (paycard.payadj = ‘P’) made on an active PTP between ptp create date (caseptp.date) and date run.

Function	IFTASKGDONE
Description	Returns either the first or last completed date of a task from a taskset.
Condition	IFTASKGDONE(value, 'taskset', 'order')
Parameters	value = ourfile (debt.ourfile)
	taskset = taskset to query (actlist.taskset)
	order = 'FIRST' for oldest entry, 'LAST' for most recent entry
Example(s)	IFTASKGDONE(debt.ourfile, 'CALENDAR', 'FIRST')
	IFTASKGDONE(debt.ourfile, 'DLETTER', 'LAST')
Notes	n/a

Returns either the first or last completed date of a task from a taskset.

Function	GETDCAL
Description	Returns values from the dcal screen or from the AOD/Docketly screen for court dates.
Condition	GETDCAL(value, 'dbr', 'type', 'field', 'hist', 'aod')
Parameters	value = ourfile (debt.ourfile)
	dbr = debtor number for court date
	type = court calendar type The GETDCAL() function was enhanced to no longer require a court type. Users can use “ANY” in the third parameter to pull the next dcal record, regardless of type. The type can still be specified as always, if needed.
	field = field from pull from DCAL
	hist = set as true (.t.) to pull the first ACTIVE record in DCAL or false (.f.) to pull the most recent record (regardless of active status). Optional unless using AOD. By default, will pull the next most recent recorc
	AOD = field to pull from AODMAIN
Example(s)	PADR(GETDCAL(debt.ourfile, '1', 'HEARING', 'DEFENDANT'),25)
	PADR(GETDCAL(debt.ourfile, '1', 'HEARING', 'DEFENDANT', .t.),25)
	PADR(GETDCAL(debt.ourfile, '1', 'HEARING', 'DEFENDANT', .t.,'ATTYRECORD' ),25)
	dtoc(GETDCAL(debt.ourfile, "1", "ANY", "COURTDATE"))
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns values from the dcal screen or from the AOD/Docketly screen for court dates.

Function	GETPTYPE
Description	Returns the most recent trx type from paycard.
Condition	GETPTYPE(value, 'trx')
Parameters	value = ourfile (debt.ourfile)
	trx = trx type from paycard (01,04,07,17,etc)
Example(s)	GETPTYPE(debt.ourfile, '01')
	ALLTRIM(STR(GETPTYPE(debt.ourfile, '07'),12,2))
Notes	Only supported in Word merge. Should use ALLTRIM and STR functions with command.

Returns the most recent trx type from paycard.

Function	MISCSEEK
Description	Returns a field from one of the tables a table where multiple records can exist for multiple borrowers (ARBITRATE, DECEASED, DGARN, DSERVE, FIN_PROF, MORT_DEF, ABKRFILE, DLIEN). Will only pull active records for DGARN and DLIEN.
Condition	MISCSEEK('table', 'dbr', 'field', 'type')
Parameters	table = table to pull record from (see description)
	dbr = borrower number for selected table
	field = field from table to query
	type = used for DGARN, DSERVE, DLIEN. For DGARN and DLIEN, enter the record type (dgarn.garntype or dlien.lientype). For DSERVE, enter the service status (dserve.status).
Example(s)	MISCSEEK('ARBITRATE', '1', 'CLAIMNO')
	DTOC(MISCSEEK('ABKRFILE', '1', 'bfiledate'))
	MISCSEEK('DECEASED', '2', 'coroner')
	ALLTRIM(STR(MISCSEEK('FIN_PROF', '1', 'bor_income'),12,2))
	MISCSEEK('MORT_DEF', '1', 'purchaser')
	MISCSEEK('DLIEN', '1', 'COURTCODE', 'MEDLIEN')
	DTOC(MISCSEEK('DSERVE', '2', 'STATUSDATE', 'SERVED'))
	ALLTRIM(STR(MISCSEEK('DGARN', '1', 'GARNBAL', 'BANKGARN'),12,2))
Notes	Only supported in Word Merge. Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc().

Returns a field from one of the tables a table where multiple records can exist for multiple borrowers (ARBITRATE, DECEASED, DGARN, DSERVE, FIN_PROF, MORT_DEF, ABKRFILE, DLIEN). Will only pull active records for DGARN and DLIEN.

Function	GETDLEGAL
Description	Get value of any field in dlegal from any dlegal record.
Condition	getdlegal(value, 'code', 'field')
Parameters	value = ourfile (debt.ourfile)
	code = dlegal.code
	field = dlegal field to query
Example(s)	GETDLEGAL(debt.ourfile, '1', 'dlegal.ctcalcode')
	GETDLEGAL(debt.ourfile, '2', 'dlegal.defendant')
Notes	n/a

Get value of any field in dlegal from any dlegal record.

Function	GETRELBUCKET
Description	Get balance of all active - not closed creditor related files.
Condition	GETRELBUCKET(value, 'bucket')
Parameters	value = ourfile (debt.ourfile)
	bucket = balance bucket to return (PRINCIP, INTEREST, ATTFEE, COST, ACHARGE, BALANCE, NUMFILES, TOTALPAID)
Example(s)	GETRELBUCKET(debt.ourfile, 'PRINCIP')
	ALLTRIM(STR(GETRELBUCKET(debt.ourfile, 'INTEREST'),12,2))
Notes	Only supported in Word merge. Should use ALLTRIM and STR functions with command.

Get balance of all active – not closed creditor related files.

Function	NEWGETFIRSTENTRY
Description	Returns the first entry from the table specified based on a where condition.
Condition	NEWGETFIRSTENTRY('table', 'field', 'condition', 'sort')
Parameters	table = table to query
	field = field to query first entry from selected table
	condition = where clause for table. If not populated, defaults to ourfile. If populated, need to include ourfile='&dfile' withing condition (see example)
	sort = how to sort field. If not populated, will default to ID
Example(s)	NEWGETFIRSTENTRY("paycard","amount","ourfile = '&ourfile' and payadj='C'", "DATE")
	PADR(NEWGETFIRSTENTRY("trans","ref + ': '+cdesc","ourfile = '&ourfile' and trx='17'"),100)
Notes	Only supported in Word Merge and DDAS. Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). When entering the condition, it is based upon the table set in function. (i.e. if table = paycard, condition will only word for paycard table).

Returns the first entry from the table specified based on a where condition.

Function	GETDLEGALCOMP
Description	Get total value of any field in dlegal for dbr1 across comp files.
Condition	getdlegalcomp(value, 'field')
Parameters	value = ourfile (debt.ourfile)
	field = dlegal field to query - should be numeric
Example(s)	GETDLEGALCOMP(debt.ourfile, 'suitamt')
Notes	n/a

Get total value of any field in dlegal for dbr1 across comp files.

Function	GETSPECIAL
Description	Returns the value of field from a special template.
Condition	GETSPECIAL(value, 'special','field')
Parameters	value = ourfile (debt.ourfile)
	special = special template name (special.special)
	field = field to pull from special
Example(s)	GETSPECIAL(debt.ourfile, 'CASEINFO', 'SPECIAL.USER5DATA')
	DTOC(GETSPECIAL(debt.ourfile, 'BANKRUPTCY', 'SPECIAL.DATE1'))
	ALLTRIM(STR(GETSPECIAL(debt.ourfile, 'ALEGIS', 'SPECIAL.AMOUNT1'),12,2))
	PADR(GETSPECIAL(debt.ourfile, 'CASEINFO', 'SPECIAL.USER5DATA'),20)
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns the value of field from a special template.

Function	NEWGETLASTENTRY
Description	Returns the last entry from the table specified based on a where condition.
Condition	NEWGETLASTENTRY('table', 'field', 'condition', 'sort')
Parameters	table = table to query
	field = field to query first entry from selected table
	condition = where clause for table. If not populated, defaults to ourfile. If populated, need to include ourfile='&dfile' withing condition (see example)
	sort = how to sort field. If not populated, will default to ID
Example(s)	NEWGETLASTENTRY("paycard","amount","ourfile = '&ourfile' and payadj='C'", "DATE")
	PADR(NEWGETLASTENTRY("trans","ref + ': '+cdesc","ourfile = '&ourfile' and trx='17'"),100)
Notes	Only supported in Word Merge and DDAS. Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). When entering the condition, it is based upon the table set in function. (i.e. if table = paycard, condition will only word for paycard table).

Returns the last entry from the table specified based on a where condition.

Function	GETDOCDATE
Description	Returns the most recent date for a document that matches the docid.
Condition	getdocdate(value, 'docid')
Parameters	value = ourfile (debt.ourfile)
	docid = docid from documents tab (scanfile.doctype)
Example(s)	GETDOCDATE(debt.ourfile, 'B12')
	GETDOCDATE(debt.ourfile, 'AFD')
Notes	If there are multiple docs with same docid, the program will find/return the most recent docdate.

Returns the most recent date for a document that matches the docid.

Function	GETSTATUS
Description	Returns the most recent record from the status table.
Condition	GETSTATUS(value, 'field', 'stattype')
Parameters	value = ourfile (debt.ourfile)
	field = status field to query
	stattype = Status type (STATUS or NOTE)
Example(s)	GETSTATUS(debt.ourfile, 'STATID', 'STATUS')
	DTOC(GETSTATUS(debt.ourfile, 'DATE', 'NOTE'))
Notes	Always returned as the type field, ex: Number, character or date For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns the most recent record from the status table.

Function	XCONTACTSEEK
Description	Lookup a specific dname record to be used in custom fields, reports & queries, vendor exports, and DDAS.
Condition	xcontactseek(value,'type','dbr','field')
Parameters	value = ourfile (debt.ourfile)
	type = dname.type
	num = dname.dbr
	field = dname field to query
Example(s)	xcontactseek(debt.ourfile,'DEB','1','FILEAS')
	xcontactseek(debt.ourfile,'FIN','2','COMPANY')
Notes	n/a

Lookup a specific dname record to be used in custom fields, reports & queries, vendor exports, and DDAS.

Function	GETNEXTPTP
Description	Returns next unpaid ptp from ptp-list.
Condition	getnextptp(value, 'dbr', 'fieldname')
Parameters	value = ourfile (debt.ourfile)
	dbr = ptp_list dbr value (borrower 1, 2, 3, etc)
	fieldname = ptp_list field to query
Example(s)	GETNEXTPTP(debt.ourfile, '2', 'PAYMETHOD')
	ALLTRIM(STR(GETNEXTPTP(debt.ourfile, '1', 'AMOUNT'),12,2))
	DTOC(GETNEXTPTP(debt.ourfile, '2', 'duedate'))
	PADR(GETNEXTPTP(debt.ourfile, '1', 'PAYMETHOD'),20)
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns next unpaid ptp from ptp-list.

Function	GETTASCOURT
Description	Returns taskcode fields for taskcodes setup for multi task docket report.
Condition	GETTASCOURT('expression', status)
Parameters	expression - fields to return from the task codes
	status - .t. to get a completed task, .f. to get active task.
Example(s)	GETTASCOURT("dtoc(deadline.date) + ' - ' + alltrim(deadline.descr)", .f.)
	GETTASCOURT("dtoc(deadline.date) + ' - ' + alltrim(deadline.descr)", .t.)
Notes	Only supported in Word merge. Works with tasks in the bigvalue of firm pref: DOCKTLIST.

Returns taskcode fields for taskcodes setup for multi task docket report.

Function	XMISCSEEK
Description	Returns a field from one of the tables a table where multiple records can exist for multiple borrowers (ARBITRATE, DECEASED, DGARN, DSERVE, FIN_PROF, MORT_DEF, ABKRFILE, DLIEN). Will only pull active records for DGARN and DLIEN.
Condition	XMISCSEEK(value, 'table', 'dbr', 'field', 'type')
Parameters	value = ourfile (debt.ourfile)
	table = table to pull record from (see description)
	dbr = borrower number for selected table
	field = field from table to query
	type = used for DGARN, DSERVE, DLIEN. For DGARN and DLIEN, enter the record type (dgarn.garntype or dlien.lientype). For DSERVE, enter the service status (dserve.status).
Example(s)	XMISCSEEK(debt.ourfile, 'ARBITRATE', '1', 'CLAIMNO')
	DTOC(XMISCSEEK(debt.ourfile, 'ABKRFILE', '1', 'bfiledate'))
	XMISCSEEK(debt.ourfile, 'DECEASED', '2', 'coroner')
	ALLTRIM(STR(xmiscseek(debt.ourfile, 'fin_prof', '1', 'bor_income'),12,2))
	XMISCSEEK(debt.ourfile, 'MORT_DEF', '1', 'purchaser')
	XMISCSEEK(debt.ourfile, 'DLIEN', '1', 'COURTCODE', 'MEDLIEN')
	DTOC(XMISCSEEK(debt.ourfile, 'DSERVE', '2', 'STATUSDATE', 'SERVED'))
	ALLTRIM(STR(XMISCSEEK(debt.ourfile, 'DGARN', '1', 'GARNBAL', 'BANKGARN'),12,2))
Notes	Always returned as the type field, ex: Number, character or date. For Numbers, use alltrim(Str(number,12,2)). For dates, use dtoc(). If using in R&Q, use PADR command to set field length.

Returns a field from one of the tables a table where multiple records can exist for multiple borrowers (ARBITRATE, DECEASED, DGARN, DSERVE, FIN_PROF, MORT_DEF, ABKRFILE, DLIEN). Will only pull active records for DGARN and DLIEN.

Functions No Longer Supported	Recommended Alternates
These functions are no longer supported in SQL. They are still in code, but are not guaranteed to work. Please use the alternate functions shown.
GETGARSHERIFF	Use XMISCSEEK to pull sheriff info directly from dgarn records.
EMPLSEEK	Use XCONTACTSEEK to locate GAR, POE, FIN records.
GETPJCOST	Use GETCOSTPJ.

These functions are no longer supported. Use the alternate functions listed.