V10 API Functions

Welcome to the SILQ API documentation. This is the documentation for Version 10 (v10) of the API.

Common Parameters

The following control parameters are common to all v10 estate and matter API calls and should be included in every request.

CONTROL PARAMETERS

Name Value
SessionToken Session ID
User User login
Password User password
Action Action to be performed. It will usually be one of the CRUD operations but is not limited to these values.

CONTROL PARAMETER EXAMPLE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Insert", ...}

  Back to top

Estate

DESCRIPTION

Create, read, update and delete estates.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • ContactGuid
  • EstateGuid
  • MatterGuid
  • If no sort value is specified, the default will be EstateGuid
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
ESTATEGUID Guid N/A
MATTERGUID Guid N/A
CONTACTGUID Guid N/A
LETTERSOFENTITLEMENT Boolean Letters Of Admnistration?
AGEATDEATH Integer Age At Death
DATEOFDEATH Date Date Of Death
PLACEOFDEATH String N/A
NAMEONDEATHCERTIFICATE String Name On Death Certificate
ADDRESSOFDECEASED String Address Of Deceased (if different to Will)
DATEOFWILL Date Date of Will
PAGESINWILL Integer Pages In Will
NAMEINWILL String Name In Will
DOCUMENTGUID Guid N/A
WITNESSTOWILL String N/A
TOTALASSETS Decimal Total Assets:
TOTALLIABILITIES Decimal Total Liabilities
ESTATEGROSSVALUE Decimal Gross Value
ESTATENETVALUE Decimal Net Value
NAMEOFTRUST String N/A
NAMEOFSUPERANNUATION String N/A
MARRIEDAFTERWILL Boolean Married After Will?
MARRIEDAFTERWILLTOWHOM String To Whom
DATEOFMARRIAGEAFTERWILL Date Date Of Marriage
NUMBEROFCODICILS Integer # Of Codicils
DATEOFCODICILS String Date/s of Codicil/s
WITNESS1TOCODICIL String Witness 1
WITNESS2TOCODICIL String Witness 2
BASISOFGRANT String Basis Of Grant
PROBATEGRANTNO String Probate Grant No
PROBATEGRANTEDTO String Probate Granted To
DATEOFGRANTOFREP Date Date of Grant
PUBLISHEDIN String Published In
PUBLISHEDDATE Date Published Date
DATEOFDISTRIBUTIONNOTICE Date Date Of Distribution Notice

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "0FAACJSEFLIGA80S", "LettersOfEntitlement": 1, "AgeAtDeath": 88, "DateOfDeath": "27/04/2021", "PlaceOfDeath": "Wollongong", "NameOnDeathCertificate": "John Smith", "AddressOfDeceased": "1 Test Street, Wollongong, NSW, 2500", "DateOfWill": "11/11/2001", "PagesInWill": 12, "TotalAssets": 250000.00, "TotalLiabilities": 30000.00, "EstateGrossValue": 220000.00, "EstateNetValue": 220000.00, "MarriedAfterWill": 1, "MarriedAfterWillToWhom": "Jane Smith", "DateOfMarriageAfterWill": "12/12/2003", "NumberOfCodicils": 1, "DateOfCodicils": "03/03/2005", "Witness1ToCodicil": "Robert Brown", "PublishedIn": "Illawarra Mercury", "PublishedDate": "29/04/2021"}}


DATA PARAMETER EXAMPLE 2- UPDATE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"EstateGuid": "6HG0DXXUM96NG4XF", "MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "0FAACJSEFLIGA80S", "LettersOfEntitlement": 1, "AgeAtDeath": 88, "DateOfDeath": "27/04/2021", "PlaceOfDeath": "Wollongong", "NameOnDeathCertificate": "John Smith", "AddressOfDeceased": "1 Test Street, Wollongong, NSW, 2500", "DateOfWill": "11/11/2001", "PagesInWill": 12, "TotalAssets": 250000.00, "TotalLiabilities": 30000.00, "EstateGrossValue": 220000.00, "EstateNetValue": 220000.00, "MarriedAfterWill": 1, "MarriedAfterWillToWhom": "Jane Smith", "DateOfMarriageAfterWill": "12/12/2003", "NumberOfCodicils": 1, "DateOfCodicils": "03/03/2005", "Witness1ToCodicil": "Robert Brown", "PublishedIn": "Illawarra Mercury", "PublishedDate": "29/04/2021"}}


DATA PARAMETER EXAMPLE 3- DELETE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"EstateGuid": "6HG0DXXUM96NG4XF"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEGUID" : "6HG0DXXUM96NG4XF",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEGUID" : "6HG0DXXUM96NG4XF",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"ESTATEGUID" : "6HG0DXXUM96NG4XF",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CONTACTGUID" : "0FAACJSEFLIGA80S",
				"LETTERSOFENTITLEMENT" : 1,
				"AGEATDEATH" : 88,
				"DATEOFDEATH" : "27/04/2021",
				"PLACEOFDEATH" : "Wollongong",
				"NAMEONDEATHCERTIFICATE" : "John Smith",
				"ADDRESSOFDECEASED" : "1 Test Street, Wollongong, NSW, 2500",
				"DATEOFWILL" : "11/11/2001",
				"PAGESINWILL" : 12,
				"NAMEINWILL" : "",
				"DOCUMENTGUID" : "",
				"WITNESSTOWILL" : "",
				"TOTALASSETS" : 250000.00,
				"TOTALLIABILITIES" : 30000.00,
				"ESTATEGROSSVALUE" : 220000.00,
				"ESTATENETVALUE" : 220000.00,
				"NAMEOFTRUST" : "",
				"NAMEOFSUPERANNUATION" : "",
				"MARRIEDAFTERWILL" : 1,
				"MARRIEDAFTERWILLTOWHOM" : "Jane Smith",
				"DATEOFMARRIAGEAFTERWILL" : "12/12/2003",
				"NUMBEROFCODICILS" : 1,
				"DATEOFCODICILS" : "74575",
				"WITNESS1TOCODICIL" : "Robert Brown",
				"WITNESS2TOCODICIL" : "",
				"BASISOFGRANT" : "",
				"PROBATEGRANTNO" : "",
				"PROBATEGRANTEDTO" : "",
				"DATEOFGRANTOFREP" : "",
				"PUBLISHEDIN" : "Illawarra Mercury",
				"PUBLISHEDDATE" : "29/04/2021",
				"DATEOFDISTRIBUTIONNOTICE" : ""
			}
		]
	}
}  
				

  Back to top

EstateAsset

DESCRIPTION

Create, read, update and delete estate assets.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • ContactGuid
  • EstateAssetGuid
  • MatterGuid
  • MatterPropertyGuid
  • If no sort value is specified, the default will be EstateAssetGuid
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
ESTATEASSETGUID Guid N/A
MATTERGUID Guid N/A
CONTACTGUID Guid N/A
CONTACTNAME String Contact Name
MATTERPROPERTYGUID Guid N/A
ASSETTYPE String Asset Type
VALUEATDEATH Decimal Value At Death
INTERESTACCRUED Decimal Interest
TOTALVALUE Decimal Total
TENANCY Enumeration (see below for more details) Tenancy
TENANTSINCOMMONSHARES Integer Tenants In Common # Shares
TENANTINCOMMONDECEASEDSHARE Decimal TIC Deceased Share
JOINTTENANTSDETAILS String TIC Names and Addresses
ASSETDESCRIPTION String Description
ACCOUNTDESCRIPTION String Account Description:
ACCOUNTDETAILS String Account Details
ASSETACTION String Action
TRANSFERREDTO String Transferred To
DATETRANSFERRED Date Date Transferred
INCLUDEINAFFIDAVIT Boolean N/A
CREATECERTDISCLOSURE Boolean N/A

FIELD VALIDATION

Name Data Type Valid Values Default
TENANCY String
  • Solely by the deceased
  • With another or others as joint tenants
  • Held as trustee
  • Tenants in common in equal shares
  • Tenants in common in unequal shares
  • Held outside state
Solely by the deceased

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "wUI2Qpoxeuu5IgMwM0VAoIk57T7gpt", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "GE8U7BR7785TO3US", "AssetType": "Money at bank", "ValueAtDeath": 76500.00, "InterestAccrued": 3456.78, "TotalValue": 79956.78, "Tenancy": "Solely by the deceased", "TenantsInCommonShares": 1, "TenantInCommonDeceasedShare": 79956.78, "AssetDescription": "Savings account", "AccountDescription": "Account Number", "AccountDetails": "062644 12345678", "AssetAction": "Closed"}}


DATA PARAMETER EXAMPLE 2- UPDATE

{"SessionToken": "wUI2Qpoxeuu5IgMwM0VAoIk57T7gpt", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"EstateAssetGuid": "XWDSFM4X1UDK0RT5", "MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "GE8U7BR7785TO3US", "AssetType": "Money at bank", "ValueAtDeath": 76500.00, "InterestAccrued": 3456.78, "TotalValue": 79956.78, "Tenancy": "Solely by the deceased", "TenantsInCommonShares": 1, "TenantInCommonDeceasedShare": 79956.78, "AssetDescription": "Savings account", "AccountDescription": "Account Number", "AccountDetails": "062644 12345678", "AssetAction": "Closed"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "wUI2Qpoxeuu5IgMwM0VAoIk57T7gpt", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"EstateAssetGuid": "XGOV3A43U9QA3LWI"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "wUI2Qpoxeuu5IgMwM0VAoIk57T7gpt", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEASSETGUID" : "XWDSFM4X1UDK0RT5",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateAssetGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEASSETGUID" : "XWDSFM4X1UDK0RT5",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateAssetGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"ESTATEASSETGUID" : "XWDSFM4X1UDK0RT5",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CONTACTGUID" : "GE8U7BR7785TO3US",
				"CONTACTNAME" : "Westpac Bank - Deceased Estates",
				"MATTERPROPERTYGUID" : "",
				"ASSETTYPE" : "Money at bank",
				"VALUEATDEATH" : 76500.00,
				"INTERESTACCRUED" : 3456.78,
				"TOTALVALUE" : 79956.78,
				"TENANCY" : "Solely by the deceased",
				"TENANTSINCOMMONSHARES" : 1,
				"TENANTINCOMMONDECEASEDSHARE" : 79956.78,
				"JOINTTENANTSDETAILS" : "",
				"ASSETDESCRIPTION" : "Savings account",
				"ACCOUNTDESCRIPTION" : "Account Number",
				"ACCOUNTDETAILS" : "062644 12345678",
				"ASSETACTION" : "Closed",
				"TRANSFERREDTO" : "",
				"DATETRANSFERRED" : "",
				"INCLUDEINAFFIDAVIT" : 0,
				"CREATECERTDISCLOSURE" : 0
			}
		]
	}
}
				

  Back to top

EstateBeneficiary

DESCRIPTION

Create, read, update and delete estate beneficiaries.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • ContactGuid
  • EstateBeneficiaryGuid
  • MatterGuid
  • If no sort value is specified, the default will be EstateBeneficiaryGuid
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
ESTATEBENEFICIARYGUID Guid N/A
MATTERGUID Guid N/A
CONTACTGUID Guid N/A
CONTACTNAME String Contact Name
ENTITLEMENTDESCRIPTION String Entitlement
VALUEOFENTITLEMENT Decimal Value Of Entitlement
NOMINALENTITLEMENT Boolean Nominal Entitlement?
RELATIONSHIPTODECEASED String Relationship To Deceased
RELINE String Re Line
BANKNAME String Bank Name
BANKBRANCH String Bank Branch
ACCOUNTNAME String Account Name
BSBNUMBER String BSB
ACCOUNTNUMBER String Account Number
HASBEENDISTRIBUTED Boolean Has been distributed?
NOTES String Notes

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "1VMU4PUB5EYJ5NIQ", "EntitlementDescription": "Fifty Thousand Dollars", "ValueOfEntitlement": 50000.00, "NominalEntitlement": 0, "RelationshipToDeceased": "Daughter", "ReLine": "", "BankName": "CBA", "BankBranch": "Figtree", "AccountName": "John Smith", "BSBNumber": "062644 12345678", "HasBeenDistributed": 1, "Notes": "Free text description can go here"}}


DATA PARAMETER EXAMPLE 2- UPDATE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"EstateBeneficiaryGuid": "AHTB5HJUDTA6EE8R", "MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "1VMU4PUB5EYJ5NIQ", "EntitlementDescription": "Fifty Thousand Dollars", "ValueOfEntitlement": 50000.00, "NominalEntitlement": 0, "RelationshipToDeceased": "Daughter", "ReLine": "", "BankName": "CBA", "BankBranch": "Figtree", "AccountName": "John Smith", "BSBNumber": "062644 12345678", "HasBeenDistributed": 1, "Notes": "Free text description can go here"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"EstateBeneficiaryGuid": "AHTB5HJUDTA6EE8R"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEBENEFICIARYGUID" : "AHTB5HJUDTA6EE8R",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateBeneficiaryGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATEBENEFICIARYGUID" : "AHTB5HJUDTA6EE8R",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateBeneficiaryGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"ESTATEBENEFICIARYGUID" : "AHTB5HJUDTA6EE8R",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CONTACTGUID" : "1VMU4PUB5EYJ5NIQ",
				"CONTACTNAME" : "Westpac Bank - Deceased Estates",
				"ENTITLEMENTDESCRIPTION" : "Fifty Thousand Dollars",
				"VALUEOFENTITLEMENT" : 50000.00,
				"NOMINALENTITLEMENT" : 0,
				"RELATIONSHIPTODECEASED" : "Daughter",
				"RELINE" : "",
				"BANKNAME" : "CBA",
				"BANKBRANCH" : "Figtree",
				"ACCOUNTNAME" : "John Smith",
				"BSBNUMBER" : "062644 123",
				"ACCOUNTNUMBER" : "",
				"HASBEENDISTRIBUTED" : 1,
				"NOTES" : "Free text description can go here"
			}
		]
	}
} 
				

  Back to top

EstateLiability

DESCRIPTION

Create, read, update and delete estate liabilities.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • ContactGuid
  • EstateLiabilityGuid
  • MatterGuid
  • If no sort value is specified, the default will be EstateLiabilityGuid
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
ESTATELIABILITYGUID Guid N/A
MATTERGUID Guid N/A
CONTACTGUID Guid N/A
CONTACTNAME String Contact Name
DATEINCURRED Date Date Incurred
LIABILITYDESCRIPTION String Description
AMOUNT Decimal Amount:
SECURED Boolean Secured?

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "8KR2UZEYAQKBQPRY", "DateIncurred": "14/04/2021", "LiabilityDescription": "Balance on credit card", "Amount": "2345.67", "Secured": 0}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"EstateLiabilityGuid": "G88L6OG31WGLF9DR", "MatterGuid":"03AQHW6QN5EP6E5C", "ContactGuid": "8KR2UZEYAQKBQPRY", "DateIncurred": "14/04/2021", "LiabilityDescription": "Balance on credit card", "Amount": "2345.67", "Secured": 0}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"EstateLiabilityGuid": "G88L6OG31WGLF9DR"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "rWTwroX1WWartZgKwucwUWsAKffgEu", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATELIABILITYGUID" : "G88L6OG31WGLF9DR",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateLiabilityGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ESTATELIABILITYGUID" : "G88L6OG31WGLF9DR",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "EstateLiabilityGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "ContactGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"ESTATELIABILITYGUID" : "G88L6OG31WGLF9DR",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CONTACTGUID" : "8KR2UZEYAQKBQPRY",
				"CONTACTNAME" : "Westpac Bank - Deceased Estates",
				"DATEINCURRED" : "14/04/2021",
				"LIABILITYDESCRIPTION" : "Balance on credit card",
				"AMOUNT" : 2345.67,
				"SECURED" : 0
			}
		]
	}
}
				

  Back to top

MatterCommercial

DESCRIPTION

Create, read, update and delete commercial matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterCommercialGuid
  • If no sort value is specified, the default will be ClassOfShares
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERCOMMERCIALGUID Guid N/A
MATTERGUID Guid N/A
CLASSOFSHARES String Class Of Shares
NUMBEROFSHARES Integer Number Of Shares
CONSIDERATION String Consideration

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ClassOfShares": "Type A", "NumberOfShares": 1250, "Consideration": "Consideration text"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterCommercialGuid": "G0EAG1MUUFXB0SBJ", "MatterGuid":"03AQHW6QN5EP6E5C", "ClassOfShares": "Type A", "NumberOfShares": 1250, "Consideration": "Consideration text"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterCommercialGuid": "G0EAG1MUUFXB0SBJ"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMMERCIALGUID" : "G0EAG1MUUFXB0SBJ",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCommercialGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMMERCIALGUID" : "G0EAG1MUUFXB0SBJ",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCommercialGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERCOMMERCIALGUID" : "G0EAG1MUUFXB0SBJ",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CLASSOFSHARES" : "Type A",
				"NUMBEROFSHARES" : 1250,
				"CONSIDERATION" : "Consideration text"
			}
		]
	}
} 
				

  Back to top

MatterCompensation

DESCRIPTION

Create, read, update and delete compensation matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterCompensationGuid
  • If no sort value is specified, the default will be AccidentDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERCOMPENSATIONGUID Guid N/A
MATTERGUID Guid N/A
ACCIDENTDATE Date Accident Date
ACCIDENTDATE2 Date N/A
ACCIDENTDATE3 Date N/A
ACCIDENTDATE4 Date N/A
DATEOFNOTICEOFINJURY Date Notice Of Injury
PLACEOFINJURY String Place Of Injury
INJURYDESCRIPTION String Injury Desc.
HOWDIDINJURYOCCUR String Cause of Injury
CLAIMNUMBER String Claim Number
INVESTIGATIONDATE Date Investigation Date
LITIGATIONFUNDER String Lit. Funder
TRANSFERREDFROMOTHERSOLICITOR Boolean Transferred From Other Solicitor
OTHERSOLICITORNAME String Solicitor Name
ESTIMATEDAWARD Decimal Est. Award
DATERECEIVEDBYINSURER Date N/A
DATESENTTOINSURER Date N/A
SETTLEMENTDATE Date Settlement Date
EXPIRATIONDATE Date Expiry Date

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "AccidentDate": "17/03/2021", "DateOfNoticeOfInjury": "22/03/2021", "PlaceOfInjury": "Town Hall Train Station", "InjuryDescription": "Broken ankle", "HowDidInjuryOccur": "Slipped on water on the steps", "ClaimNumber": "PAS-1678235670", "InvestigationDate": "24/03/2021", "LitigationFunder": "Claimant", "TransferredFromOtherSolicitor": 1, "OtherSolicitorName": "Dennis Denuto", "EstimatedAward": 25000.00, "DateReceivedByInsurer": "02/04/2021", "DateSentToInsurer": "01/04/2021", "SettlementDate": "23/04/2021", "ExpirationDate": "28/05/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterCompensationGuid": "LCDZ34HWV2UCBZSF", "MatterGuid":"03AQHW6QN5EP6E5C", "AccidentDate": "17/03/2021", "DateOfNoticeOfInjury": "22/03/2021", "PlaceOfInjury": "Town Hall Train Station", "InjuryDescription": "Broken ankle", "HowDidInjuryOccur": "Slipped on water on the steps", "ClaimNumber": "PAS-1678235670", "InvestigationDate": "24/03/2021", "LitigationFunder": "Claimant", "TransferredFromOtherSolicitor": 1, "OtherSolicitorName": "Dennis Denuto", "EstimatedAward": 25000.00, "DateReceivedByInsurer": "02/04/2021", "DateSentToInsurer": "01/04/2021", "SettlementDate": "23/04/2021", "ExpirationDate": "28/05/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterCompensationGuid": "LCDZ34HWV2UCBZSF"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMPENSATIONGUID" : "LCDZ34HWV2UCBZSF",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCompensationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMPENSATIONGUID" : "LCDZ34HWV2UCBZSF",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCompensationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERCOMPENSATIONGUID" : "LCDZ34HWV2UCBZSF",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"ACCIDENTDATE" : "17/03/2021",
				"ACCIDENTDATE2" : "",
				"ACCIDENTDATE3" : "",
				"ACCIDENTDATE4" : "",
				"DATEOFNOTICEOFINJURY" : "22/03/2021",
				"PLACEOFINJURY" : "Town Hall Train Station",
				"INJURYDESCRIPTION" : "Broken ankle",
				"HOWDIDINJURYOCCUR" : "Slipped on water on the steps",
				"CLAIMNUMBER" : "PAS-1678235670",
				"INVESTIGATIONDATE" : "24/03/2021",
				"LITIGATIONFUNDER" : "Claimant",
				"TRANSFERREDFROMOTHERSOLICITOR" : 1,
				"OTHERSOLICITORNAME" : "Dennis Denuto",
				"ESTIMATEDAWARD" : 25000,
				"DATERECEIVEDBYINSURER" : "2/04/2021",
				"DATESENTTOINSURER" : "1/04/2021",
				"SETTLEMENTDATE" : "23/04/2021",
				"EXPIRATIONDATE" : "28/05/2021"
			}
		]
	}
}  
				

  Back to top

MatterCompulsoryAcquisition

DESCRIPTION

Create, read, update and delete matter compulsory acquisition details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterCompulsoryAcquisitionGuid
  • If no sort value is specified, the default will be DateOfAcquisition
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERCOMPULSORYACQUISITIONGUID Guid N/A
MATTERGUID Guid N/A
CLIENTVALUATION Decimal Client Valuation
AUTHORITYVALUATION Decimal Auth. Valuation
DATEOFACQUISITION Date N/A
COMPENSATIONAMOUNT Decimal N/A
DATENOTICESENT Date N/A
DETERMINATIONISSUED Boolean N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ClientValuation": 5000000.00, "AuthorityValuation": 4000000, "DateOfAcquisition": "13/03/2021", "CompensationAmount": 250000.00, "DateNoticeSent": "20/03/2021", "DeterminationIssued": 0}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterCompulsoryAcquisitionGuid": "NWGXTGE27YCYAL1R", "MatterGuid":"03AQHW6QN5EP6E5C", "ClientValuation": 5000000.00, "AuthorityValuation": 4000000, "DateOfAcquisition": "13/03/2021", "CompensationAmount": 250000.00, "DateNoticeSent": "20/03/2021", "DeterminationIssued": 0}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterCompulsoryAcquisitionGuid": "NWGXTGE27YCYAL1R"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "urRoAmMxepF6j90iYaeyY4KPgLdnoy", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMPULSORYACQUISITIONGUID" : "NWGXTGE27YCYAL1R",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCompulsoryAcquisitionGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCOMPULSORYACQUISITIONGUID" : "NWGXTGE27YCYAL1R",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCompulsoryAcquisitionGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERCOMPULSORYACQUISITIONGUID" : "NWGXTGE27YCYAL1R",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"CLIENTVALUATION" : 5000000,
				"AUTHORITYVALUATION" : 4000000,
				"DATEOFACQUISITION" : "13/03/2021",
				"COMPENSATIONAMOUNT" : 250000,
				"DATENOTICESENT" : "20/03/2021",
				"DETERMINATIONISSUED" : 0
			}
		]
	}
} 
				

  Back to top

MatterConveyancing

DESCRIPTION

Create, read, update and delete conveyancing matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterConveyancingGuid
  • If no sort value is specified, the default will be ExchangeDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERCONVEYANCINGGUID Guid N/A
MATTERGUID Guid N/A
PURCHASEPRICE Decimal Purchase Price
GST Decimal GST
OTHERCONSIDERATION Decimal Other Consideration
TENANCY Boolean N/A
DEPOSITTYPE String Deposit Type
INITIALDEPOSIT Decimal Initial Deposit
DEPOSITAMOUNT Decimal Deposit Amount
DEPOSITBONDAMOUNT Decimal Deposit Bond
DEPOSITBONDEXPIRYDATE Date Deposit Bond Expiry Date
BALANCEDEPOSIT Decimal Balance Deposit
BALANCEDEPOSITDATE Date Balance of Deposit Due
EXCHANGEDATE Date Exchange Date
COOLINGOFFDATE Date Cooling Off Date
CONTRACTLENGTHVALUE Decimal Contract Length
CONTRACTLENGTHPERIODTYPE Enumeration (see below for more details) Drop down next to Contract Length
CONTRACTCOMPLETIONDATE Date Contract Completion Date
CONTRACTCOMPLETIONOTHERDATE Date Contract Completion Other Date
AUCTIONDATE Date Auction Date
FINALDATEFORNOTICETOCOMPLETE Date Final Date For Notice To Complete
TRANSFERFEESEXCLUDED Boolean Transfer Fees Excluded
DUPLICATEDOCUMENTS Integer Duplicate Documents
DUPLICATETRANSFERS Integer Duplicate Transfers
ENOSID String eNOS Id
PROPERTYTYPE String Property Type
ELIGIBLEFORSTAMPDUTYREDUCTION Boolean Eligible For Stamp Duty Reduction
FIRSTHOMEOWNERSGRANT Boolean First Home Owners Grant
NEWHOMEGRANT Boolean New Home Grant
ELIGIBLEPURCHASERPERCENTAGE Decimal Eligible Purchaser Percentage
EXEMPTFROMPREMIUMPROPERTYDUTY Boolean Exempt From Premium Property Duty
STAMPDUTYAMOUNT Decimal Stamp Duty
STAMPDUTYDUEDATE Date Stamp Duty Due
STAMPDUTYPAIDDATE Date Stamp Duty Paid
OSRRECEIPTNO String OSR Receipt No
STAMPDUTYREFUND Decimal N/A
FOREIGNPURCHASER Boolean Foreign Purchaser
DUTIBLEAMOUNT Decimal Dutible Amount
ADDITIONALDUTY Decimal Additional Duty
LODGEMENTFEE Decimal Lodgement Fee
ADVALOREMFEE Decimal Ad Valorem Fee
TOTALREGISTRATIONFEES Decimal Total Registration Fees
FINANCEDATE Date Finance Date
BANKREFERENCE String Bank Ref
DATEPAID Date Date Paid
BUILDINGREPORTCOMPLETED Boolean Building Report Completed
PESTREPORTCOMPLETED Boolean Pest Report Completed
SPECIALCONDITIONS String Special Conditions
ADJUSTMENTDATE Date Adjustment Date
PAYABLEBYPURCHASER Decimal Payable By Purchaser
PAYABLEBYVENDOR Decimal Payable By Vendor
TOTALDUE Decimal Total Due
CHEQUESDUE Decimal Cheques Due
UNPAIDAMOUNT Decimal Unpaid Amount
CLIENTSTATUS Enumeration (see below for more details) Status
VENDORPAYS Enumeration (see below for more details) Who pays for settlement day?
SETTLEMENTDATE Date Settlement Date
SETTLEMENTTIME Time Settlement Time
POOLINSPECTIONDATE Date Pool Inspection Date
PESTINSPECTIONDATE Date Pest Inspection Date

FIELD VALIDATION

Name Data Type Valid Values Default
CLIENTSTATUS String
  • Unexchanged
  • Exchanged
  • In Progress
  • Cooling Off
  • Complete
No value specified
CONTRACTLENGTHPERIODTYPE String
  • Days
  • Weeks
  • Months
  • Years
No value specified
VENDORPAYS String
  • System Default
  • Vendor Pays
  • Purchasor Pays
No value specified

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "GoiWdh9bbgC7RRr9ZXhOAY4xUU4Tdu", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "PurchasePrice": 750000.00, "GST": 68181.82, "OtherConsideration": 10000.00, "Tenancy": 0, "InitialDeposit": 75000.00, "DepositBondAmount": 750.00, "DepositBondExpiryDate": "14/04/2021", "BalanceDeposit": 75000.00, "ExchangeDate": "14/04/2021", "CoolingOffDate": "28/04/2021", "StampDutyAmount": "29085.00", "StampDutyDueDate": "12/05/2021", "StampDutyPaidDate": "07/05/2021", "ForeignPurchaser": 0, "SettlementDate": "14/05/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken":"Xvkpg7y8gmi7NaX5Z0QuecoYEsnS6t", "User": "user@example.com", "Password": "test", "Action": "Update", "VALIDATEONLY":false, "Data":{"MATTERGUID":"VNB85F78U49LZSBP", "MATTERCONVEYANCINGGUID":"OWONYWPRCBR4Q0HK", "EXCHANGEDATE":"4/03/2022", "ADJUSTMENTDATE":"", "SETTLEMENTDATE":"25/03/2022", "CLIENTSTATUS":"Unexchanged", "PURCHASEPRICE":1350000, "DEPOSITTYPE":"", "INITIALDEPOSIT":0, "BALANCEDEPOSIT":0, "BALANCEDEPOSITDATE":"", "DEPOSITBONDAMOUNT":0, "DEPOSITBONDEXPIRYDATE":"", "DEPOSITAMOUNT":0, "GST":0, "OTHERCONSIDERATION":0, "COOLINGOFFDATE":"", "CONTRACTLENGTHVALUE":0, "CONTRACTLENGTHPERIODTYPE":"", "CONTRACTCOMPLETIONDATE":"", "CONTRACTCOMPLETIONOTHERDATE":"", "AUCTIONDATE":"", "FINALDATEFORNOTICETOCOMPLETE":"", "TRANSFERFEESEXCLUDED":0, "DUPLICATEDOCUMENTS":0, "DUPLICATETRANSFERS":0, "ENOSID":"", "PROPERTYTYPE":"", "ELIGIBLEFORSTAMPDUTYREDUCTION":0, "FIRSTHOMEOWNERSGRANT":0, "NEWHOMEGRANT":0, "ELIGIBLEPURCHASERPERCENTAGE":0, "EXEMPTFROMPREMIUMPROPERTYDUTY":0, "FOREIGNPURCHASER":0, "DUTIBLEAMOUNT":0, "ADDITIONALDUTY":0, "LODGEMENTFEE":0, "ADVALOREMFEE":0, "TOTALREGISTRATIONFEES":0, "STAMPDUTYAMOUNT":0, "STAMPDUTYDUEDATE":"", "STAMPDUTYPAIDDATE":"", "OSRRECEIPTNO":"", "FINANCEDATE":"", "BANKREFERENCE":"", "BUILDINGREPORTCOMPLETED":0, "PESTREPORTCOMPLETED":0, "SPECIALCONDITIONS":"", "PAYABLEBYPURCHASER":0, "PAYABLEBYVENDOR":0, "TOTALDUE":1350000, "CHEQUESDUE":0, "UNPAIDAMOUNT":1350000, "VENDORPAYS":"System Default", "DATEPAID":"", "SETTLEMENTTIME": "04:00pm", "POOLINSPECTIONDATE": "18/03/2022", "PESTINSPECTIONDATE": "19/03/2022", "SETTLEMENTLOCATION": "Conveyancer's Office"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "GoiWdh9bbgC7RRr9ZXhOAY4xUU4Tdu", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterConveyancingGuid": "5E0PWOND8OHNAIPG"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "GoiWdh9bbgC7RRr9ZXhOAY4xUU4Tdu", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCONVEYANCINGGUID" : "5E0PWOND8OHNAIPG",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterConveyancingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCONVEYANCINGGUID" : "5E0PWOND8OHNAIPG",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterConveyancingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"RECORDS": [{
			"MATTERCONVEYANCINGGUID": "OWONYWPRCBR4Q0HK",
			"MATTERGUID": "VNB85F78U49LZSBP",
			"PURCHASEPRICE": 1350000.00,
			"GST": 0.00,
			"OTHERCONSIDERATION": 0.00,
			"TENANCY": 0,
			"DEPOSITTYPE": "",
			"INITIALDEPOSIT": 0.00,
			"DEPOSITAMOUNT": 0.00,
			"DEPOSITBONDAMOUNT": 0.00,
			"DEPOSITBONDEXPIRYDATE": "",
			"BALANCEDEPOSIT": 0.00,
			"BALANCEDEPOSITDATE": "",
			"EXCHANGEDATE": "4/03/2022",
			"COOLINGOFFDATE": "",
			"CONTRACTLENGTHVALUE": 0,
			"CONTRACTLENGTHPERIODTYPE": "",
			"CONTRACTCOMPLETIONDATE": "",
			"CONTRACTCOMPLETIONOTHERDATE": "",
			"AUCTIONDATE": "",
			"FINALDATEFORNOTICETOCOMPLETE": "",
			"TRANSFERFEESEXCLUDED": 0,
			"DUPLICATEDOCUMENTS": 0,
			"DUPLICATETRANSFERS": 0,
			"ENOSID": "",
			"PROPERTYTYPE": "",
			"ELIGIBLEFORSTAMPDUTYREDUCTION": 0,
			"FIRSTHOMEOWNERSGRANT": 0,
			"NEWHOMEGRANT": 0,
			"ELIGIBLEPURCHASERPERCENTAGE": 0,
			"EXEMPTFROMPREMIUMPROPERTYDUTY": 0,
			"STAMPDUTYAMOUNT": 0.00,
			"STAMPDUTYDUEDATE": "",
			"STAMPDUTYPAIDDATE": "",
			"OSRRECEIPTNO": "",
			"STAMPDUTYREFUND": 0.00,
			"FOREIGNPURCHASER": 0,
			"DUTIBLEAMOUNT": 0.00,
			"ADDITIONALDUTY": 0.00,
			"LODGEMENTFEE": 0.00,
			"ADVALOREMFEE": 0.00,
			"TOTALREGISTRATIONFEES": 0.00,
			"FINANCEDATE": "",
			"BANKREFERENCE": "",
			"DATEPAID": "",
			"BUILDINGREPORTCOMPLETED": 0,
			"PESTREPORTCOMPLETED": 0,
			"SPECIALCONDITIONS": "",
			"ADJUSTMENTDATE": "",
			"PAYABLEBYPURCHASER": 0.00,
			"PAYABLEBYVENDOR": 0.00,
			"TOTALDUE": 1350000.00,
			"CHEQUESDUE": 0.00,
			"UNPAIDAMOUNT": 1350000.00,
			"CLIENTSTATUS": "Unexchanged",
			"VENDORPAYS": "System Default",
			"SETTLEMENTDATE": "25/03/2022",
			"SETTLEMENTTIME": "4:00PM",
			"POOLINSPECTIONDATE": "18/03/2022",
			"PESTINSPECTIONDATE": "19/03/2022",
			"SETTLEMENTLOCATION": "Conveyancer's Office"
		}]
	}
}
				

  Back to top

MatterCriminal

DESCRIPTION

Create, read, update and delete criminal matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterCriminalGuid
  • If no sort value is specified, the default will be BriefServiceDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERCRIMINALGUID Guid N/A
MATTERGUID Guid N/A
BRIEFSERVICEDATE Date Brief Service Date
COMMITTALDATE Date Committal Date
REPLYDATE Date Reply Date
JUVENILE Boolean Juvenile
WAIVEROFCOMMITTAL Boolean Waiver of Commital
BAILDATE Date Bail Date
BAILRESTRICTIONS String Bail Restrictions
OUTCOME String Outcome
SENTENCINGDATE Date Sentencing Date
SENTENCE String Sentence
S91APPLICATION Boolean S91 Application
S93APPLICATION Boolean S93 Application
OFFENCEDATE Date Offence Date
CUSTODYNUMBER String Custody No
CUSTODYLOCATION String Custody Location:
OFFICERINCHARGE String N/A
CHARGENUMBER String Charge No
CRIMINALNAMEINDEX String Crim. Name Index
LEGALAIDREFERENCE String Legal Aid Ref

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "BriefServiceDate": "03/03/2021", "CommittalDate": "04/04/2021", "ReplyDate": "18/04/201", "Juvenile": 0, "BailDate": "05/05/2021", "BailRestrictions": "6pm-6am curfew", "Outcome": "Home Detention", "SentencingDate": "10/05/2021", "Sentence": "6 months", "S91Application": 1, "S93Application": 0, "OffenceDate": "05/01/2021", "CustodyNumber": "CN123ABC456", "CustodyLocation": "Illawarra Reintegration Centre", "OfficerInCharge": "Agent Smith", "ChargeNumber": "NSW-113653WC", "CriminalNameIndex": "NRS 32767", "LegalAidReference": "REF-XDR376190345"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterCriminalGuid": "67CPTJIRAWD109OU", "MatterGuid":"03AQHW6QN5EP6E5C", "BriefServiceDate": "03/03/2021", "CommittalDate": "04/04/2021", "ReplyDate": "18/04/201", "Juvenile": 0, "BailDate": "05/05/2021", "BailRestrictions": "6pm-6am curfew", "Outcome": "Home Detention", "SentencingDate": "10/05/2021", "Sentence": "6 months", "S91Application": 1, "S93Application": 0, "OffenceDate": "05/01/2021", "CustodyNumber": "CN123ABC456", "CustodyLocation": "Illawarra Reintegration Centre", "OfficerInCharge": "Agent Smith", "ChargeNumber": "NSW-113653WC", "CriminalNameIndex": "NRS 32767", "LegalAidReference": "REF-XDR376190345"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterCriminalGuid": "67CPTJIRAWD109OU"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCRIMINALGUID" : "67CPTJIRAWD109OU",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCriminalGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERCRIMINALGUID" : "67CPTJIRAWD109OU",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterCriminalGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERCRIMINALGUID" : "67CPTJIRAWD109OU",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"BRIEFSERVICEDATE" : "3/03/2021",
				"COMMITTALDATE" : "4/04/2021",
				"REPLYDATE" : "",
				"JUVENILE" : 0,
				"WAIVEROFCOMMITTAL" : 0,
				"BAILDATE" : "5/05/2021",
				"BAILRESTRICTIONS" : "6pm-6am curfew",
				"OUTCOME" : "Home Detention",
				"SENTENCINGDATE" : "10/05/2021",
				"SENTENCE" : "6 months",
				"S91APPLICATION" : 1,
				"S93APPLICATION" : 0,
				"OFFENCEDATE" : "5/01/2021",
				"CUSTODYNUMBER" : "CN123ABC456",
				"CUSTODYLOCATION" : "Illawarra Reintegration Centre",
				"OFFICERINCHARGE" : "Agent Smith",
				"CHARGENUMBER" : "NSW-113653WC",
				"CRIMINALNAMEINDEX" : "NRS 32767",
				"LEGALAIDREFERENCE" : "REF-XDR376190345"
			}
		]
	}
}  
				

  Back to top

MatterDebtRecovery

DESCRIPTION

Create, read, update and delete debt recovery matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterDebtRecoveryGuid
  • If no sort value is specified, the default will be DebtDueDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERDEBTRECOVERYGUID Guid N/A
MATTERGUID Guid N/A
DEBTAMOUNT Decimal Debt Amount
DEBTDUEDATE Date Debt Due Date
INTERESTRATETYPE Enumeration (see below for more details) Interest Type
INTERESTRATE Decimal Interest Rate
INTERESTENDDATE Date Interest End Date
INTERESTTODATE Decimal Interest To Date
FILINGFEES Decimal Filing Fees
SERVICEFEES Decimal Service Fees
SOLICITORSFEES Decimal Solicitors Fees
TOTALDEBT Decimal Total Debt
AMOUNTRECOVERED Decimal Amount Recovered
BALANCEOWING Decimal Balance Owing
DEFAULTJUDGEMENTDATE Date Default Judgement Date
DJINTERESTRATE Decimal DJ Interest Rate
INTERESTSINCEDEFAULTJUDGEMENT Decimal Interest Since DJ
ADDITIONALSERVICEFEES Decimal Addit. Service Fees
GARNISHEETOTAL Decimal Garnishee Total
FINALPAYMENTDATE Date Final Payment Date:
REPAYMENTDETAILS String Repayment Details
REVIEWDATE Date Review Date

FIELD VALIDATION

Name Data Type Valid Values Default
INTERESTRATETYPE String
  • Compound
  • Simple
No value specified

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "DebtAmount": 200000.00, "DebtDueDate": "28/02/2034", "InterestRateType": "Variable", "InterestRate": 2.25, "FilingFees": 275.00, "ServiceFees": 110.00, "SolicitorsFees": 495.00, "TotalDebt": 200880.00, "AmountRecovered": 1000.00, "BalanceOwing": 199880.00, "DefaultJudgementDate": "19/05/2021", "GarnisheeTotal": 199880.00}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterDebtRecoveryGuid": "NIQVXTQ8X5I31W2W", "MatterGuid":"03AQHW6QN5EP6E5C", "DebtAmount": 200000.00, "DebtDueDate": "28/02/2034", "InterestRateType": "Variable", "InterestRate": 2.25, "FilingFees": 275.00, "ServiceFees": 110.00, "SolicitorsFees": 495.00, "TotalDebt": 200880.00, "AmountRecovered": 1000.00, "BalanceOwing": 199880.00, "DefaultJudgementDate": "19/05/2021", "GarnisheeTotal": 199880.00}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterDebtRecoveryGuid": "NIQVXTQ8X5I31W2W"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERDEBTRECOVERYGUID" : "NIQVXTQ8X5I31W2W",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterDebtRecoveryGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERDEBTRECOVERYGUID" : "NIQVXTQ8X5I31W2W",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterDebtRecoveryGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERDEBTRECOVERYGUID" : "NIQVXTQ8X5I31W2W",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"DEBTAMOUNT" : 200000,
				"DEBTDUEDATE" : "28/02/2034",
				"INTERESTRATETYPE" : 0,
				"INTERESTRATE" : 2.25,
				"INTERESTENDDATE" : "",
				"INTERESTTODATE" : 0,
				"FILINGFEES" : 275,
				"SERVICEFEES" : 110,
				"SOLICITORSFEES" : 495,
				"TOTALDEBT" : 200880,
				"AMOUNTRECOVERED" : 1000,
				"BALANCEOWING" : 199880,
				"DEFAULTJUDGEMENTDATE" : "19/05/2021",
				"DJINTERESTRATE" : 0,
				"INTERESTSINCEDEFAULTJUDGEMENT" : 0,
				"ADDITIONALSERVICEFEES" : 0,
				"GARNISHEETOTAL" : 199880,
				"FINALPAYMENTDATE" : "",
				"REPAYMENTDETAILS" : "",
				"REVIEWDATE" : ""
			}
		]
	}
} 
				

  Back to top

MatterExpertProcess

DESCRIPTION

Create, read, update and delete expert process matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterExpertProcessGuid
  • If no sort value is specified, the default will be ExpertAgreementDateSigned
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTEREXPERTPROCESSGUID Guid N/A
MATTERGUID Guid N/A
EXPERTAGREEMENTDATESIGNED Date N/A
EXPERTCONFIDENTIALITYDATESIGNED Date N/A
EXPERTDOCSEXCHANGEDDATE Date N/A
EXPERTSUBMISSIONSDATE Date N/A
EXPERTHEARINGDATE Date N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "ExpertAgreementDateSigned": "11/11/2020", "ExpertConfidentialityDateSigned": "12/12/2020", "ExpertDocsExchangedDate": "02/02/2021", "ExpertSubmissionsDate": "03/03/2021", "ExpertHearingDate": "04/04/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterExpertProcessGuid": "AY7INS1KOZ3S2WR9", "MatterGuid":"03AQHW6QN5EP6E5C", "ExpertAgreementDateSigned": "11/11/2020", "ExpertConfidentialityDateSigned": "12/12/2020", "ExpertDocsExchangedDate": "02/02/2021", "ExpertSubmissionsDate": "03/03/2021", "ExpertHearingDate": "04/04/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterExpertProcessGuid": "AY7INS1KOZ3S2WR9"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTEREXPERTPROCESSGUID" : "AY7INS1KOZ3S2WR9",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterExpertProcessGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTEREXPERTPROCESSGUID" : "AY7INS1KOZ3S2WR9",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterExpertProcessGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTEREXPERTPROCESSGUID" : "AY7INS1KOZ3S2WR9",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"EXPERTAGREEMENTDATESIGNED" : "11/11/2020",
				"EXPERTCONFIDENTIALITYDATESIGNED" : "12/12/2020",
				"EXPERTDOCSEXCHANGEDDATE" : "2/02/2021",
				"EXPERTSUBMISSIONSDATE" : "3/03/2021",
				"EXPERTHEARINGDATE" : "4/04/2021"
			}
		]
	}
} 
				

  Back to top

MatterFamilyLaw

DESCRIPTION

Create, read, update and delete family law matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterFamilyLawGuid
  • If no sort value is specified, the default will be MarriageDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERFAMILYLAWGUID Guid N/A
MATTERGUID Guid N/A
COHABITATIONDATE Date Cohabitation Date
MARRIAGEDATE Date Marriage Date
MARRIAGEPLACE String Marriage Place
MARRIAGECOUNTRY String Marriage Country
SEPARATIONDATE String Separation Date
DATEFILEDFORDIVORCE Date Date Filed For Divorce
DIVORCEDATE Date Divorce Date
DIVORCEPLACE String Divorce Place
DIVORCECOUNTRY String Divorce Country
NUMDEPENDANTS Integer Num Dependants
FAMILYCOURTCLIENTID String Fam Crt Client Id
EXPIRATIONDATE Date Expiry Date

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "CohabitationDate": "01/04/1984", "MarriageDate": "11/11/1984", "MarriagePlace": "Wollongong", "MarriageCountry": "Australia", "SeparationDate": "08/08/2020", "DateFiledForDivorce": "02/02/2021", "DivorceDate": "23/04/2021", "DivorcePlace": "Sydney", "DivorceCountry": "Australia", "NumDependants": 2, "FamilyCourtClientId": "FCNSW2345678", "ExpirationDate": "28/05/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterFamilyLawGuid": "ZR0SNG29RRT5A0M5", "MatterGuid":"03AQHW6QN5EP6E5C", "CohabitationDate": "01/04/1984", "MarriageDate": "11/11/1984", "MarriagePlace": "Wollongong", "MarriageCountry": "Australia", "SeparationDate": "08/08/2020", "DateFiledForDivorce": "02/02/2021", "DivorceDate": "23/04/2021", "DivorcePlace": "Sydney", "DivorceCountry": "Australia", "NumDependants": 2, "FamilyCourtClientId": "FCNSW2345678", "ExpirationDate": "28/05/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterFamilyLawGuid": "ZR0SNG29RRT5A0M5"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERFAMILYLAWGUID" : "ZR0SNG29RRT5A0M5",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterFamilyLawGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERFAMILYLAWGUID" : "ZR0SNG29RRT5A0M5",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterFamilyLawGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERFAMILYLAWGUID" : "ZR0SNG29RRT5A0M5",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"COHABITATIONDATE" : "1/04/1984",
				"MARRIAGEDATE" : "11/11/1984",
				"MARRIAGEPLACE" : "Wollongong",
				"MARRIAGECOUNTRY" : "Australia",
				"SEPARATIONDATE" : "08/08/2020",
				"DATEFILEDFORDIVORCE" : "2/02/2021",
				"DIVORCEDATE" : "23/04/2021",
				"DIVORCEPLACE" : "Sydney",
				"DIVORCECOUNTRY" : "Australia",
				"NUMDEPENDANTS" : 2,
				"FAMILYCOURTCLIENTID" : "FCNSW2345678",
				"EXPIRATIONDATE" : "28/05/2021"
			}
		]
	}
}  
				

  Back to top

MatterImmigration

DESCRIPTION

Create, read, update and delete immigration matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterImmigrationGuid
  • If no sort value is specified, the default will be LodgementDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERIMMIGRATIONGUID Guid N/A
MATTERGUID Guid N/A
ANTICIPATEDDATEOFENTRY Date Anticipated Entry
LODGEMENTDATE Date Lodgement Date
VISAEXPIRYDATE Date Visa Expiry Date
DECISIONDUEDATE Date Decision Due Date
VALUEOFASSETS Decimal Assets
VISATYPE String Visa Type
VISASTATUS String Visa Status

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "AnticipatedDateOfEntry": "19/05/2021", "LodgementDate": "05/05/2021", "VisaExpiryDate": "19/08/2021", "DecisionDueDate": "14/05/2021", "ValueOfAssets": 12500.00, "VisaType": "Student", "VisaStatus": "Pending"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterImmigrationGuid": "UKP1I7VZCD4UBFNK", "MatterGuid":"03AQHW6QN5EP6E5C", "AnticipatedDateOfEntry": "19/05/2021", "LodgementDate": "05/05/2021", "VisaExpiryDate": "19/08/2021", "DecisionDueDate": "14/05/2021", "ValueOfAssets": 12500.00, "VisaType": "Student", "VisaStatus": "Pending"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterImmigrationGuid": "UKP1I7VZCD4UBFNK"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERIMMIGRATIONGUID" : "UKP1I7VZCD4UBFNK",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterImmigrationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERIMMIGRATIONGUID" : "UKP1I7VZCD4UBFNK",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterImmigrationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERIMMIGRATIONGUID" : "UKP1I7VZCD4UBFNK",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"ANTICIPATEDDATEOFENTRY" : "19/05/2021",
				"LODGEMENTDATE" : "5/05/2021",
				"VISAEXPIRYDATE" : "19/08/2021",
				"DECISIONDUEDATE" : "14/05/2021",
				"VALUEOFASSETS" : 12500,
				"VISATYPE" : "Student",
				"VISASTATUS" : "Pending"
			}
		]
	}
} 
				

  Back to top

MatterLeasing

DESCRIPTION

Create, read, update and delete leasing matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterLeasingGuid
  • If no sort value is specified, the default will be LeaseCommencementDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERLEASINGGUID Guid N/A
MATTERGUID Guid N/A
LEASERECEIVED Boolean Lease Received
DATEEXECUTED Date Date Executed
EXECUTIONDATEBYLESSOR Date Executed By Lessor
EXECUTIONDATEBYLESSEE Date Executed By Lessee
REGISTRATIONDATE Date Registration Date
VALIDUNTIL Date Valid Until
LEASECOMMENCEMENTDATE Date Lease Start Date
LEASETERMINATIONDATE Date Lease End Date
LEASINGREGISTEREDNUMBER String Registered Number
TERMOFLEASE String Term Of Lease
PERMITTEDUSE String Permitted Use
DISCLOSUREDATE Date Disclosure Date
LETTABLEAREASQM Decimal Lettable Area SqM
RELATESTORETIREMENTVILLAGE Boolean Relates To Retirement Village
ACCESSOUTSIDETRADINGHOURS String Access Outside Trading Hours
RETAILSHOPLEASE Boolean Retail Shop Lease
REIMBURSEMENTFORGSTBYTENANT Decimal Reimb. For GST By Tenant
STAMPDUTYDOCUMENTS Integer Stamp Duty Documents
OPTIONDATE Date Option Date
OPTIONPERIOD String Option Period
OPTIONDESCRIPTION String Option Desc.
ANNUALRENTAL Decimal Annual Rental
ANNUALRENTALCLAUSE String Annual Rental Clause
GSTPAYABLE Boolean GST Payable
RENTPAYABLEONWHATDAY String Rent Payable On What Day
RENTALAMOUNT Decimal Rental Amount
RENTALPERIOD Enumeration (see below for more details) per
OUTGOINGS Decimal Outgoings
SECURITYDEPOSIT Decimal Security Deposit
SECURITYDEPOSITTYPE String Security Deposit Type
OVERDUERENTINTERESTRATE Decimal Overdue Rent Int %
RENTSTARTDATE Date Rent Start Date
RENTFREESTARTDATE Date Start Date
RENTFREEUNITS Decimal Units
RENTFREECLAUSE String Clause
RENTFREEPERIOD Enumeration (see below for more details) Drop down next to Units
RENTFREEAMOUNT Decimal Amount
RENTFREEOVERRIDEAMOUNT Decimal Override Amount
YEAR2AMOUNT Decimal Year 2 [under Yearly Amount]
YEAR3AMOUNT Decimal Year 3 [under Yearly Amount]
YEAR4AMOUNT Decimal Year 4 [under Yearly Amount]
YEAR5AMOUNT Decimal Year 5 [under Yearly Amount]
YEAR6AMOUNT Decimal Year 6 [under Yearly Amount]
YEAR7AMOUNT Decimal Year 7 [under Yearly Amount]
YEAR8AMOUNT Decimal Year 8 [under Yearly Amount]
YEAR9AMOUNT Decimal Year 9 [under Yearly Amount]
YEAR10AMOUNT Decimal Year 10 [under Yearly Amount]
YEAR2INSTALMENT Decimal Year 2 [under Period Instalment]
YEAR3INSTALMENT Decimal Year 3 [under Period Instalment]
YEAR4INSTALMENT Decimal Year 4 [under Period Instalment]
YEAR5INSTALMENT Decimal Year 5 [under Period Instalment]
YEAR6INSTALMENT Decimal Year 6 [under Period Instalment]
YEAR7INSTALMENT Decimal Year 7 [under Period Instalment]
YEAR8INSTALMENT Decimal Year 8 [under Period Instalment]
YEAR9INSTALMENT Decimal Year 9 [under Period Instalment]
YEAR10INSTALMENT Decimal Year 10 [under Period Instalment]
PUBLICLIABAMOUNT Decimal Required Amount
PUBLICLIABPREMIUM Decimal Premium
PUBLICLIABPREMIUMCLAUSE String Clause
PUBLICLIABSTAMPDUTY Decimal Stamp Duty
PUBLICLIABPAYABLE String Payable When?
PUBLICLIABINTERESTOFLESSOR String Interest Of Lessor
RENTALINCREASES String N/A
RENTFORMULA String Formula
RENTREVIEWFREQUENCY String Frequency
RENTREVIEWNATURE String Nature
RENTREVIEWCLAUSE String Clause
RENTREVIEWFIXEDAMOUNT Decimal Fixed Amount
RENTREVIEWCURRENTCPI Decimal Current CPI
RENTREVIEWFIXEDPERCENT Decimal Fixed Percent
RENTREVIEWMARKETRENTPERCENT Decimal Market Rent Percent
ABATEMENTOFRENT String N/A
ASSIGNEMENTANDSUBLETTING String N/A
REPAIRS String N/A
INSURANCES String N/A
DEFAULTANDESSENTIALITEMS String N/A
COUNCILSCONSENTTOUSE String N/A
ASSIGNMENTSTARTDATE Date N/A
ASSIGNMENTENDDATE Date N/A
ASSIGNMENTBUSINESSTYPE String N/A
PURSUANTTOSALEOFDUTIABLEPROPERTY Boolean N/A
ASSIGNMENTCONSIDERATION String N/A
ASSIGNMENTSTAMPDUTY Decimal N/A
DETAILSOFCARSPOTS String N/A
CARPARKANNUALFEE Decimal N/A
CARPARKMONTHLYFEE Decimal N/A
CARPARKISHEADLICENCE Boolean N/A
FINISHESFIXTURESPROVIDEDBYLESSOR Boolean N/A
FINISHESFIXTURESPAIDBYLESSEE Boolean N/A
FINISHESFIXTURESPAIDBYLESSEEDETAILS String N/A
FINISHESFIXTURESPROVIDEDBYLESSEE Boolean N/A
FINISHESFIXTURESQUALITYREQUIREMENTS String N/A
DISCLOSUREAGREEMENTS String N/A
DISCLOSUREREDOCATIONDATES String N/A
DISCLOSUREDATEPROPERTYAVAILABLE Date N/A
SHOPNO String N/A
SHOPPINGCENTERNAME String N/A
SHOPPINGCENTREADDRESS String N/A
SHOPPINGCENTRESUBURB String N/A
SHOPPINGCENTREPOSTCODE String N/A
NUMBEROFSHOPSINCENTRE Integer N/A
TOTALLETTABLEAREA Decimal N/A
CARBAYSFORCUSTOMERS Integer N/A
CARBAYSFORTENANTS Integer N/A
SHOPPINGCENTRECORETRADINGHOURS String N/A
FACILITIESPROVIDEDBYLESSOR String N/A
PLANSTODEVELOPCENTRE Boolean N/A
PLANSTODEVELOPSURROUNDINGROADS Boolean N/A
TENANTASSOCIATION Boolean N/A
CONTRIBUTETOADVERTISING Boolean N/A
ADVERTISINGAMOUNT Decimal N/A
ADVERTISINGBASERENTPERCENT Decimal N/A
ADVERTISINGINCREASEMETHOD String N/A
ADVERTISINGISADDITIONRENT Boolean N/A
LESSORISOWNER Boolean N/A
LESSORISLESSEE Boolean N/A
LESSORISLESSEEOBLIGATIONS String N/A
LESSORISLESSSAGREEMENTS String N/A
ADDITIONALLEASEDPROPERTY String N/A

FIELD VALIDATION

Name Data Type Valid Values Default
RENTALPERIOD String
  • Week
  • Month
  • Quarter
  • Year
No value specified
RENTFREEPERIOD String
  • Week
  • Month
  • Quarter
  • Year
No value specified

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "LeaseReceived": "23/04/2021", "DateExecuted": "27/04/2021", "ExecutionDateByLessor": "28/04/2021", "ExecutionDateByLessee": "29/04/2021", "ValidUntil": "11/05/2021", "LeaseCommencementDate": "17/05/2021", "LeaseTerminationDate": "16/11/2021", "LettableAreaSqM": 120.00, "RentalAmount": 4000.00, "RentalPeriod": "Month"}}


DATA PARAMETER EXAMPLE 2- UPDATE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterLeasingGuid": "OLJ0T6PVLX3T08ES", "MatterGuid":"03AQHW6QN5EP6E5C", "LeaseReceived": "23/04/2021", "DateExecuted": "27/04/2021", "ExecutionDateByLessor": "28/04/2021", "ExecutionDateByLessee": "29/04/2021", "ValidUntil": "11/05/2021", "LeaseCommencementDate": "17/05/2021", "LeaseTerminationDate": "16/11/2021", "LettableAreaSqM": 120.00, "RentalAmount": 4000.00, "RentalPeriod": "Month"}}


DATA PARAMETER EXAMPLE 3- DELETE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterLeasingGuid": "OLJ0T6PVLX3T08ES"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "bdhoEKXwGGM5k7jOllNfU2SD1a1ehe", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERLEASINGGUID" : "OLJ0T6PVLX3T08ES",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterLeasingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERLEASINGGUID" : "OLJ0T6PVLX3T08ES",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterLeasingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERLEASINGGUID" : "OLJ0T6PVLX3T08ES",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"LEASERECEIVED" : 23,
				"DATEEXECUTED" : "27/04/2021",
				"EXECUTIONDATEBYLESSOR" : "28/04/2021",
				"EXECUTIONDATEBYLESSEE" : "29/04/2021",
				"REGISTRATIONDATE" : "",
				"VALIDUNTIL" : "8/01/1801",
				"LEASECOMMENCEMENTDATE" : "17/05/2021",
				"LEASETERMINATIONDATE" : "16/11/2021",
				"LEASINGREGISTEREDNUMBER" : "",
				"TERMOFLEASE" : "",
				"PERMITTEDUSE" : "",
				"DISCLOSUREDATE" : "",
				"LETTABLEAREASQM" : 120,
				"RELATESTORETIREMENTVILLAGE" : 0,
				"ACCESSOUTSIDETRADINGHOURS" : "",
				"RETAILSHOPLEASE" : 0,
				"REIMBURSEMENTFORGSTBYTENANT" : 0,
				"STAMPDUTYDOCUMENTS" : 0,
				"OPTIONDATE" : "",
				"OPTIONPERIOD" : "",
				"OPTIONDESCRIPTION" : "",
				"ANNUALRENTAL" : 0,
				"ANNUALRENTALCLAUSE" : "",
				"GSTPAYABLE" : "",
				"RENTPAYABLEONWHATDAY" : "",
				"RENTALAMOUNT" : 4000,
				"RENTALPERIOD" : "Month",
				"OUTGOINGS" : 0,
				"SECURITYDEPOSIT" : 0,
				"SECURITYDEPOSITTYPE" : "",
				"OVERDUERENTINTERESTRATE" : 0,
				"RENTSTARTDATE" : "",
				"RENTFREESTARTDATE" : "",
				"RENTFREEUNITS" : 0,
				"RENTFREECLAUSE" : "",
				"RENTFREEPERIOD" : "",
				"RENTFREEAMOUNT" : 0,
				"RENTFREEOVERRIDEAMOUNT" : 0,
				"YEAR2AMOUNT" : 0,
				"YEAR3AMOUNT" : 0,
				"YEAR4AMOUNT" : 0,
				"YEAR5AMOUNT" : 0,
				"YEAR6AMOUNT" : 0,
				"YEAR7AMOUNT" : 0,
				"YEAR8AMOUNT" : 0,
				"YEAR9AMOUNT" : 0,
				"YEAR10AMOUNT" : 0,
				"YEAR2INSTALMENT" : 0,
				"YEAR3INSTALMENT" : 0,
				"YEAR4INSTALMENT" : 0,
				"YEAR5INSTALMENT" : 0,
				"YEAR6INSTALMENT" : 0,
				"YEAR7INSTALMENT" : 0,
				"YEAR8INSTALMENT" : 0,
				"YEAR9INSTALMENT" : 0,
				"YEAR10INSTALMENT" : 0,
				"PUBLICLIABAMOUNT" : 0,
				"PUBLICLIABPREMIUM" : 0,
				"PUBLICLIABPREMIUMCLAUSE" : "",
				"PUBLICLIABSTAMPDUTY" : 0,
				"PUBLICLIABPAYABLE" : "",
				"PUBLICLIABINTERESTOFLESSOR" : "",
				"RENTALINCREASES" : "",
				"RENTFORMULA" : "",
				"RENTREVIEWFREQUENCY" : "",
				"RENTREVIEWNATURE" : "",
				"RENTREVIEWCLAUSE" : "",
				"RENTREVIEWFIXEDAMOUNT" : 0,
				"RENTREVIEWCURRENTCPI" : 0,
				"RENTREVIEWFIXEDPERCENT" : 0,
				"RENTREVIEWMARKETRENTPERCENT" : 0,
				"ABATEMENTOFRENT" : "",
				"ASSIGNEMENTANDSUBLETTING" : "",
				"REPAIRS" : "",
				"INSURANCES" : "",
				"DEFAULTANDESSENTIALITEMS" : "",
				"COUNCILSCONSENTTOUSE" : "",
				"ASSIGNMENTSTARTDATE" : "",
				"ASSIGNMENTENDDATE" : "",
				"ASSIGNMENTBUSINESSTYPE" : "",
				"PURSUANTTOSALEOFDUTIABLEPROPERTY" : 0,
				"ASSIGNMENTCONSIDERATION" : "",
				"ASSIGNMENTSTAMPDUTY" : 0,
				"DETAILSOFCARSPOTS" : "",
				"CARPARKANNUALFEE" : 0,
				"CARPARKMONTHLYFEE" : 0,
				"CARPARKISHEADLICENCE" : 0,
				"FINISHESFIXTURESPROVIDEDBYLESSOR" : 0,
				"FINISHESFIXTURESPAIDBYLESSEE" : 0,
				"FINISHESFIXTURESPAIDBYLESSEEDETAILS" : "",
				"FINISHESFIXTURESPROVIDEDBYLESSEE" : 0,
				"FINISHESFIXTURESQUALITYREQUIREMENTS" : "",
				"DISCLOSUREAGREEMENTS" : "",
				"DISCLOSUREREDOCATIONDATES" : "",
				"DISCLOSUREDATEPROPERTYAVAILABLE" : "",
				"SHOPNO" : "",
				"SHOPPINGCENTERNAME" : "",
				"SHOPPINGCENTREADDRESS" : "",
				"SHOPPINGCENTRESUBURB" : "",
				"SHOPPINGCENTREPOSTCODE" : "",
				"NUMBEROFSHOPSINCENTRE" : 0,
				"TOTALLETTABLEAREA" : 0,
				"CARBAYSFORCUSTOMERS" : 0,
				"CARBAYSFORTENANTS" : 0,
				"SHOPPINGCENTRECORETRADINGHOURS" : "",
				"FACILITIESPROVIDEDBYLESSOR" : "",
				"PLANSTODEVELOPCENTRE" : 0,
				"PLANSTODEVELOPSURROUNDINGROADS" : 0,
				"TENANTASSOCIATION" : 0,
				"CONTRIBUTETOADVERTISING" : 0,
				"ADVERTISINGAMOUNT" : 0,
				"ADVERTISINGBASERENTPERCENT" : 0,
				"ADVERTISINGINCREASEMETHOD" : "",
				"ADVERTISINGISADDITIONRENT" : 0,
				"LESSORISOWNER" : 0,
				"LESSORISLESSEE" : 0,
				"LESSORISLESSEEOBLIGATIONS" : "",
				"LESSORISLESSSAGREEMENTS" : "",
				"ADDITIONALLEASEDPROPERTY" : ""
			}
		]
	}
}
				

  Back to top

MatterMediation

DESCRIPTION

Create, read, update and delete mediation matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterMediationGuid
  • If no sort value is specified, the default will be MediationDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERMEDIATIONGUID Guid N/A
MATTERGUID Guid N/A
MEDIATIONDATE Date N/A
MEDIATIONNUMDAYS Integer N/A
MEDIATIONAGREEMENTSIGNED Date N/A
MEDIATIONNOTES String N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "MediationDate": "28/04/2021", "MediationNumDays": 3, "MediationAgreementSigned": "10/05/2021", "MediationNotes": "Suitable compromise found"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterMediationGuid": "INY8HG049BY9SC32", "MatterGuid":"03AQHW6QN5EP6E5C", "MediationDate": "28/04/2021", "MediationNumDays": 3, "MediationAgreementSigned": "10/05/2021", "MediationNotes": "Suitable compromise found"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterMediationGuid": "INY8HG049BY9SC32"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERMEDIATIONGUID" : "INY8HG049BY9SC32",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterMediationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERMEDIATIONGUID" : "INY8HG049BY9SC32",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterMediationGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERMEDIATIONGUID" : "INY8HG049BY9SC32",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"MEDIATIONDATE" : "28/04/2021",
				"MEDIATIONNUMDAYS" : 3,
				"MEDIATIONAGREEMENTSIGNED" : "7/01/1801",
				"MEDIATIONNOTES" : "Suitable compromise found"
			}
		]
	}
} 
				

  Back to top

MatterMortgage

DESCRIPTION

Create, read, update and delete mortgage matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterMortgageGuid
  • MatterPropertyGuid
  • If no sort value is specified, the default will be CommencementDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERMORTGAGEGUID Guid N/A
MATTERGUID Guid N/A
MATTERPROPERTYGUID Guid N/A
PRINCIPALADVANCED Decimal Principal Advanced
INTERESTRATE Decimal Interest Rate
COMMENCEMENTDATE Date Commencement Date
DISCHARGEDATE Date Discharge Date
SECURITYPROPERTY String Security Property
EXPIRATIONDATE Date Expiry Date

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken" : "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Insert", "Data": {"MatterGuid": "03AQHW6QN5EP6E5C", "PrincipalAdvanced": 550000.00, "InterestRate": 0.25, "CommencementDate": "01/05/2021", "DischargeDate": "30/04/2046", "ExpirationDate": "31/05/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken" : "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Update", "Data": {"MatterMortgageGuid": "5HUT5W798RCS8W2E", "MatterGuid": "03AQHW6QN5EP6E5C", "PrincipalAdvanced": 550000.00, "InterestRate": 0.25, "CommencementDate": "01/05/2021", "DischargeDate": "30/04/2046", "ExpirationDate": "31/05/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterMortgageGuid": "5HUT5W798RCS8W2E"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERMORTGAGEGUID" : "5HUT5W798RCS8W2E",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterMortgageGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERMORTGAGEGUID" : "5HUT5W798RCS8W2E",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterMortgageGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERMORTGAGEGUID" : "5HUT5W798RCS8W2E",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"MATTERPROPERTYGUID" : "",
				"PRINCIPALADVANCED" : 550000,
				"INTERESTRATE" : 0.25,
				"COMMENCEMENTDATE" : "1/05/2021",
				"DISCHARGEDATE" : "30/04/2046",
				"SECURITYPROPERTY" : "",
				"EXPIRATIONDATE" : "31/05/2021"
			}
		]
	}
} 
				

  Back to top

MatterProperty

DESCRIPTION

Create, read, update and delete property matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterPropertyGuid
  • If no sort value is specified, the default will be TitleReference
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERPROPERTYGUID Guid N/A
MATTERGUID Guid N/A
ESTATEASSETGUID Guid N/A
MATTERPROPERTYID Integer N/A
TITLEREFERENCE String Title Ref(s) - separate with commas
NATUREOFBUILDING String Nature Of Building
TENANCY Boolean N/A
BUILDINGNAME String Building Name
PROPLOTNUMBER String N/A
UNITNUMBER String Unit No
STREETNUMBER String Street No
STREETNUMBERTO String To
STREETNAME String Street
STREETTYPE Enumeration (see below for more details) Street Type
SUBURB String Suburb
STATE Enumeration (see below for more details) State
POSTCODE String Post Code
LOCALITY String Locality
COUNCIL String Council
PARISH String Parish
COUNCILPROPERTYNUMBER String Council Property No
SPI String SPI
VOLUME String Volume(s) [row 1]
FOLIOID String Folio Id(s) [row 1]
LOTS String Lot(s) [row 1]
PLANTYPE Enumeration (see below for more details) Plan Type(s) [row 1]
PLANNUMBER String Plan No(s) [row 1]
VOLUME2 String Volume(s) [row 2]
FOLIOID2 String Folio Id(s) [row 2]
LOT2 String Lot(s) [row 2]
PLANTYPE2 Enumeration (see below for more details) Plan Type(s) [row 2]
PLANNUMBER2 String Plan No(s) [row 2]
VOLUME3 String Volume(s) [row 3]
FOLIOID3 String Folio Id(s) [row 3]
LOT3 String Lot(s) [row 3]
PLANTYPE3 Enumeration (see below for more details) Plan Type(s) [row 3]
PLANNUMBER3 String Plan No(s) [row 3]
VOLUME4 String Volume(s) [row 4]
FOLIOID4 String Folio Id(s) [row 4]
LOT4 String Lot(s) [row 4]
PLANTYPE4 Enumeration (see below for more details) Plan Type(s) [row 4]
PLANNUMBER4 String Plan No(s) [row 4]
VOLUME5 String Volume(s) [row 5]
FOLIOID5 String Folio Id(s) [row 5]
LOT5 String Lot(s) [row 5]
PLANTYPE5 Enumeration (see below for more details) Plan Type(s) [row 5]
PLANNUMBER5 String Plan No(s) [row 5]
LOTSECTION String Section
BLOCK String Block
STAGENUMBER String Stage No
REDEVELOPMENTNUMBER String Redevelopment No
CROWNALLOTMENT String Allotment
CROWNBLOCK String Block
CROWNSECTION String Section
CROWNPORTION String Portion
CROWNSUBDIVISION String Sub Division
CROWNPARISH String Parish
STRATAPLANNUMBER String Strata Plan Number
BYLAWTYPE String By Law Type
BYLAWNO String By Law No
SPECIALRESOLUTIONDATE Date Resolution Date
AGGREGATIONOFENTITLEMENT Integer Aggr. of Entitlement
TOTALUNITS Integer Total Units
STRATAEXPIRATIONDATE Date N/A
NEARESTCROSSSTREET String N/A
FRONTAGE Decimal N/A
DEPTHOFPROPERTY Decimal N/A
AREAOFPROPERTY Decimal N/A
INCLUSIONS String N/A
EXCLUSIONS String N/A
PARENTVOLUME String Volume
PARENTFOLIOID String Folio Id
PARENTLOT String Lot
PARENTPLANTYPE String Plan Type
PARENTPLANNUMBER String Plan No
PARENTSECTION String N/A
PARENTCROWNALLOTMENT String Crown Allotment
PARENTCROWNSECTION String Crown Section
PARENTCROWNBLOCK String Crown Block
PARENTCROWNPORTION String Crown Portion
TICNAME1 String N/A
TICNOSHARES1 Decimal N/A
TICNAME2 String N/A
TICNOSHARES2 Decimal N/A
TICNAME3 String N/A
TICNOSHARES3 Decimal N/A
TICNAME4 String N/A
TICNOSHARES4 Decimal N/A
TICNAME5 String N/A
TICNOSHARES5 Decimal N/A
TICNAME6 String N/A
TICNOSHARES6 Decimal N/A
MINIMUMINSURANCE Decimal N/A
INSURER String N/A
INSURANCEEXPIRYDATE Date N/A
POLICYNUMBER String N/A

FIELD VALIDATION

Name Data Type Valid Values Default
STREETTYPE String
  • Alley
  • Arcade
  • Avenue
  • Boulevard
  • Circle
  • Circuit
  • Circus
  • Close
  • Court
  • Cresent
  • Drive
  • Grove
  • Hill
  • Junction
  • Lane
  • Loop
  • Mews
  • Parade
  • Pass
  • Path
  • Place
  • Reserve
  • Road
  • Strand
  • Street
No value specified
STATE String
  • New South Wales
  • Queensland
  • Victoria
  • Australian Capital Territory
  • Northern Territory
  • South Australia
  • Tasmania
  • Western Australia
No value specified
PLANTYPE String
  • CP
  • DP
  • SP
No value specified
PLANTYPE2 String
  • CP
  • DP
  • SP
No value specified
PLANTYPE3 String
  • CP
  • DP
  • SP
No value specified
PLANTYPE4 String
  • CP
  • DP
  • SP
No value specified
PLANTYPE5 String
  • CP
  • DP
  • SP
No value specified

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken" : "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Insert", "Data": {"MatterGuid": "03AQHW6QN5EP6E5C", "TitleReference": "22/32767", "NatureOfBuilding": "Unit", "UnitNumber": 123, "StreetNumber": 22, "StreetName": "Acacia", "StreetType": "Avenue", "Suburb": "Figtree", "State": "NSW", "PostCode": "2525", "Locality": "Illawarra", "Council": "Wollongong City Council", "Lots": "42", "PlanType": "DP", "PlanNumber": "134269"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken" : "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Update", "Data": {"MatterPropertyGuid": "O2CZC4L4T5AXO8NQ", "MatterGuid": "03AQHW6QN5EP6E5C", "TitleReference": "22/32767", "NatureOfBuilding": "Unit", "UnitNumber": 123, "StreetNumber": 22, "StreetName": "Acacia", "StreetType": "Avenue", "Suburb": "Figtree", "State": "NSW", "PostCode": "2525", "Locality": "Illawarra", "Council": "Wollongong City Council", "Lots": "42", "PlanType": "DP", "PlanNumber": "134269"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterPropertyGuid": "O2CZC4L4T5AXO8NQ"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "t5kRfFiEIQNGkTF4TyK6d3XyTHGA5i", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERPROPERTYGUID" : "O2CZC4L4T5AXO8NQ",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterPropertyGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERPROPERTYGUID" : "O2CZC4L4T5AXO8NQ",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterPropertyGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERPROPERTYGUID" : "O2CZC4L4T5AXO8NQ",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"ESTATEASSETGUID" : "",
				"MATTERPROPERTYID" : 0,
				"TITLEREFERENCE" : "22/32767",
				"NATUREOFBUILDING" : "Unit",
				"TENANCY" : 0,
				"BUILDINGNAME" : "",
				"PROPLOTNUMBER" : "",
				"UNITNUMBER" : "123",
				"STREETNUMBER" : "22",
				"STREETNUMBERTO" : "",
				"STREETNAME" : "Acacia",
				"STREETTYPE" : "Avenue",
				"SUBURB" : "Figtree",
				"STATE" : "NSW",
				"POSTCODE" : "2525",
				"LOCALITY" : "Illawarra",
				"COUNCIL" : "Wollongong City Council",
				"PARISH" : "",
				"COUNCILPROPERTYNUMBER" : "",
				"SPI" : "",
				"VOLUME" : "",
				"FOLIOID" : "",
				"LOTS" : "42",
				"PLANTYPE" : "DP",
				"PLANNUMBER" : "134269",
				"VOLUME2" : "",
				"FOLIOID2" : "",
				"LOT2" : "",
				"PLANTYPE2" : "",
				"PLANNUMBER2" : "",
				"VOLUME3" : "",
				"FOLIOID3" : "",
				"LOT3" : "",
				"PLANTYPE3" : "",
				"PLANNUMBER3" : "",
				"VOLUME4" : "",
				"FOLIOID4" : "",
				"LOT4" : "",
				"PLANTYPE4" : "",
				"PLANNUMBER4" : "",
				"VOLUME5" : "",
				"FOLIOID5" : "",
				"LOT5" : "",
				"PLANTYPE5" : "",
				"PLANNUMBER5" : "",
				"LOTSECTION" : "",
				"BLOCK" : "",
				"STAGENUMBER" : "",
				"REDEVELOPMENTNUMBER" : "",
				"CROWNALLOTMENT" : "",
				"CROWNBLOCK" : "",
				"CROWNSECTION" : "",
				"CROWNPORTION" : "",
				"CROWNSUBDIVISION" : "",
				"CROWNPARISH" : "",
				"STRATAPLANNUMBER" : "",
				"BYLAWTYPE" : "",
				"BYLAWNO" : "",
				"SPECIALRESOLUTIONDATE" : "",
				"AGGREGATIONOFENTITLEMENT" : 0,
				"TOTALUNITS" : 0,
				"STRATAEXPIRATIONDATE" : "",
				"NEARESTCROSSSTREET" : "",
				"FRONTAGE" : 0,
				"DEPTHOFPROPERTY" : 0,
				"AREAOFPROPERTY" : 0,
				"INCLUSIONS" : "",
				"EXCLUSIONS" : "",
				"PARENTVOLUME" : "",
				"PARENTFOLIOID" : "",
				"PARENTLOT" : "",
				"PARENTPLANTYPE" : "",
				"PARENTPLANNUMBER" : "",
				"PARENTSECTION" : "",
				"PARENTCROWNALLOTMENT" : "",
				"PARENTCROWNSECTION" : "",
				"PARENTCROWNBLOCK" : "",
				"PARENTCROWNPORTION" : "",
				"TICNAME1" : "",
				"TICNOSHARES1" : 0,
				"TICNAME2" : "",
				"TICNOSHARES2" : 0,
				"TICNAME3" : "",
				"TICNOSHARES3" : 0,
				"TICNAME4" : "",
				"TICNOSHARES4" : 0,
				"TICNAME5" : "",
				"TICNOSHARES5" : 0,
				"TICNAME6" : "",
				"TICNOSHARES6" : 0,
				"MINIMUMINSURANCE" : 0,
				"INSURER" : "",
				"INSURANCEEXPIRYDATE" : "",
				"POLICYNUMBER" : ""
			}
		]
	}
} 
				

  Back to top

MatterTrademark

DESCRIPTION

Create, read, update and delete trademark matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterTrademarkGuid
  • If no sort value is specified, the default will be ApplicationNo
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERTRADEMARKGUID Guid N/A
MATTERGUID Guid N/A
APPLICATIONNO String Application No
APPLICATIONDATE Date N/A
JURISDICTION String N/A
TYPEOFTRADEMARK String N/A
TRADEMARKCLASSES String N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken" : "qpJpYGibl4Ikbnixx4DLwGvbmXghkM","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Insert", "Data": {"MatterGuid": "03AQHW6QN5EP6E5C", "ApplicationNo": "ABC112233456", "ApplicationDate": "03/05/2021", "Jurisdiction": "Australia", "TypeOfTrademark": "Brand name", "TrademarkClasses": "Class 28"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken" : "qpJpYGibl4Ikbnixx4DLwGvbmXghkM","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Update", "Data": {"MatterTrademarkGuid": "0KWE3R5Y0CPXYWJU", "MatterGuid": "03AQHW6QN5EP6E5C", "ApplicationNo": "ABC112233456", "ApplicationDate": "03/05/2021", "Jurisdiction": "Australia", "TypeOfTrademark": "Brand name", "TrademarkClasses": "Class 28"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "qpJpYGibl4Ikbnixx4DLwGvbmXghkM", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterTrademarkGuid": "0KWE3R5Y0CPXYWJU"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken" : "qpJpYGibl4Ikbnixx4DLwGvbmXghkM","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "GetData", "Filters": {"MatterGuid": "03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERTRADEMARKGUID" : "0KWE3R5Y0CPXYWJU",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterTrademarkGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERTRADEMARKGUID" : "0KWE3R5Y0CPXYWJU",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterTrademarkGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERTRADEMARKGUID" : "0KWE3R5Y0CPXYWJU",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"APPLICATIONNO" : "ABC112233456",
				"APPLICATIONDATE" : "3/05/2021",
				"JURISDICTION" : "Australia",
				"TYPEOFTRADEMARK" : "Brand name",
				"TRADEMARKCLASSES" : "Class 28"
			}
		]
	}
} 
				

  Back to top

MatterTraining

DESCRIPTION

Create, read, update and delete training matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterTrainingGuid
  • If no sort value is specified, the default will be TrainingDate
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERTRAININGGUID Guid N/A
MATTERGUID Guid N/A
TRAININGDATE Date N/A
TRAININGNUMDAYS Integer N/A
TRAININGTOPIC String N/A
TRAININGCONTRACTSIGNEDDATE Date N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"MatterGuid":"03AQHW6QN5EP6E5C", "TrainingDate": "03/05/2021", "TrainingNumDays": 2, "TrainingTopic": "What is the meaning of life?", "TrainingContractSignedDate": "20/04/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"MatterTrainingGuid": "UMJANTTAUFSQMQQL", "MatterGuid":"03AQHW6QN5EP6E5C", "TrainingDate": "03/05/2021", "TrainingNumDays": 2, "TrainingTopic": "What is the meaning of life?", "TrainingContractSignedDate": "20/04/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterTrainingGuid": "UMJANTTAUFSQMQQL"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERTRAININGGUID" : "UMJANTTAUFSQMQQL",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterTrainingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERTRAININGGUID" : "UMJANTTAUFSQMQQL",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterTrainingGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERTRAININGGUID" : "UMJANTTAUFSQMQQL",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"TRAININGDATE" : "3/05/2021",
				"TRAININGNUMDAYS" : 2,
				"TRAININGTOPIC" : "What is the meaning of life?",
				"TRAININGCONTRACTSIGNEDDATE" : "20/04/2021"
			}
		]
	}
}  
				

  Back to top

MatterVessel

DESCRIPTION

Create, read, update and delete vessel matter details.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • MatterGuid
  • MatterVesselGuid
  • If no sort value is specified, the default will be VesselName
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Label in web application
MATTERVESSELGUID Guid N/A
MATTERGUID Guid N/A
VESSELNAME String Vessel Name
VESSELFLAG String Flag
VESSELTYPE String Vessel Type
TONNAGE String Tonnage
VESSELMASTER String Master
VESSELLOCATION String Location
INCIDENTDATE Date Incident Date

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken" : "rGun1v5PTT2ucyOBshzCEuLnWezP6C","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Insert", "Data": {"MatterGuid": "03AQHW6QN5EP6E5C", "VesselName": "Wollongong", "VesselFlag": "Australia", "VesselType": "Paddle Steamer", "Tonnage": 22.4, "VesselMaster": "Jean-Luc Picard", "VesselLocation": "Echuca", "IncidentDate": "09/05/2021"}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken" : "rGun1v5PTT2ucyOBshzCEuLnWezP6C","User" : "user@example.com","Password" : "test","EmailAddress" : "", "Action": "Update", "Data": {"MatterVesselGuid": "PKAZONDLVD1GGS0Y", "MatterGuid": "03AQHW6QN5EP6E5C", "VesselName": "Wollongong", "VesselFlag": "Australia", "VesselType": "Paddle Steamer", "Tonnage": 22.4, "VesselMaster": "Jean-Luc Picard", "VesselLocation": "Echuca", "IncidentDate": "09/05/2021"}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"MatterVesselGuid": "PKAZONDLVD1GGS0Y"}}


FILTERS PARAMETER EXAMPLE

{"SessionToken": "rGun1v5PTT2ucyOBshzCEuLnWezP6C", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"MatterGuid":"03AQHW6QN5EP6E5C"}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERVESSELGUID" : "PKAZONDLVD1GGS0Y",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterVesselGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"MATTERVESSELGUID" : "PKAZONDLVD1GGS0Y",
		"VALIDATIONS" : [
			{
				"FIELDNAME" : "MatterVesselGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			},
			{
				"FIELDNAME" : "MatterGuid",
				"VALUEVALID" : "Yes",
				"ERRORDESCRIPTION" : ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"MATTERVESSELGUID" : "PKAZONDLVD1GGS0Y",
				"MATTERGUID" : "03AQHW6QN5EP6E5C",
				"VESSELNAME" : "Wollongong",
				"VESSELFLAG" : "Australia",
				"VESSELTYPE" : "Paddle Steamer",
				"TONNAGE" : "22.4",
				"VESSELMASTER" : "Jean-Luc Picard",
				"VESSELLOCATION" : "Echuca",
				"INCIDENTDATE" : "9/05/2021"
			}
		]
	}
} 
				

  Back to top

ContactParent

DESCRIPTION

Create, read, update and delete contact parent details. These records define relationships between person contacts, company contacts and multi person contacts.


REQUEST PARAMETERS

Name Required Value
Standard control parameters Yes

See here for more details.

Supported values for the Action parameter:

  • To create a record - Insert
  • To retrieve record(s) - GetData
  • To update a record - Update
  • To delete a record - Delete

ValidateOnly No Validate an update or delete request without performing the actual CRUD operation
Sort No Supported values:
  • ContactGuid
  • ContactParentGuid
  • ParentGuid
  • If no sort value is specified, the default will be ContactGuid
Data Yes for Insert, Update and Delete actions Object containing the fields to be upserted
Filters Yes for GetData actions Object containing MatterGuid to filter by

AVAILABLE FIELDS

Field Name Data Type Description
CONTACTPARENTGUID Guid Record ID
CONTACTGUID Guid Contact ID of the person contact
PARENTGUID Guid Contact ID of the company contact or multi person contact the person contact is being attached against
DEFAULTPARENT Boolean If attached to multiple parent contacts, this is the default parent
USEPARENTADDRESS Boolean Use the company/client address
PRIMARYCONTACT Boolean N/A
RELATIONSHIPTYPE Integer N/A

DATA PARAMETER EXAMPLE 1 - INSERT

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Insert", "Data": {"ContactGuid": "MOI3P756LWCTPOMO", "ParentGuid": "6IFXEASA309DOCL7", "DefaultParent": 1, "UseParentAddress": 0, "PrimaryContact": 0, "RelationshipType": 0}}


DATA PARAMETER EXAMPLE 2 - UPDATE

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Update", "Data": {"ContactParentGuid": "YQAGKUK1C8QKBYLO", "ContactGuid": "MOI3P756LWCTPOMO", "ParentGuid": "6IFXEASA309DOCL7", "DefaultParent": 1, "UseParentAddress": 0, "PrimaryContact": 0, "RelationshipType": 0}}


DATA PARAMETER EXAMPLE 3 - DELETE

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "Delete", "Data": {"ContactParentGuid": "YQAGKUK1C8QKBYLO"}}


FILTERS PARAMETER EXAMPLE - RETRIEVE PEOPLE ATTACHED TO A COMPANY

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"ParentGuid":"6IFXEASA309DOCL7"}}


FILTERS PARAMETER EXAMPLE - RETRIEVE COMPANIES A PERSON IS ATTACHED TO

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"ContactGuid":"MOI3P756LWCTPOMO"}}


FILTERS PARAMETER EXAMPLE - RETRIEVE PRIMARY COMPANY A PERSON IS ATTACHED TO

{"SessionToken": "p6udVXu2bEJDk5DVy1iydUAaVzJ8Rd", "User": "user@example.com", "Password": "test", "Action": "GetData", "Filters": {"ContactGuid":"MOI3P756LWCTPOMO", "DefaultParent": 1}}


RESPONSE EXAMPLE 1 - INSERT

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"CONTACTPARENTGUID": "YQAGKUK1C8QKBYLO",
		"VALIDATIONS": [{
				"FIELDNAME": "ContactParentGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			},
			{
				"FIELDNAME": "ContactGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			},
			{
				"FIELDNAME": "ParentGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 2 - UPDATE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"CONTACTPARENTGUID": "YQAGKUK1C8QKBYLO",
		"VALIDATIONS": [{
				"FIELDNAME": "ContactParentGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			},
			{
				"FIELDNAME": "ContactGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			},
			{
				"FIELDNAME": "ParentGuid",
				"VALUEVALID": "Yes",
				"ERRORDESCRIPTION": ""
			}
		]
	}
}
				

RESPONSE EXAMPLE 3 - GETDATA (People attached to a company)

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"RECORDS": [{
				"CONTACTPARENTGUID": "YQAGKUK1C8QKBYLO",
				"CONTACTGUID": "MOI3P756LWCTPOMO",
				"CONTACTNAME": "Lars Ulrich",
				"CONTACTPHONE": "",
				"CONTACTMOBILE": "",
				"CONTACTEMAIL": "",
				"PARENTGUID": "6IFXEASA309DOCL7",
				"PARENTCONTACTNAME": "Metallica",
				"PARENTCONTACTPHONE": "",
				"PARENTCONTACTMOBILE": "",
				"PARENTCONTACTEMAIL": "",
				"DEFAULTPARENT": 1,
				"USEPARENTADDRESS": 0,
				"PRIMARYCONTACT": 0,
				"RELATIONSHIPTYPE": 0
			},
			{
				"CONTACTPARENTGUID": "EOQDFI0A4XUSTEA4",
				"CONTACTGUID": "NEXKJOPTAX4NECAM",
				"CONTACTNAME": "Kirk Hammett",
				"CONTACTPHONE": "",
				"CONTACTMOBILE": "",
				"CONTACTEMAIL": "",
				"PARENTGUID": "6IFXEASA309DOCL7",
				"PARENTCONTACTNAME": "Metallica",
				"PARENTCONTACTPHONE": "",
				"PARENTCONTACTMOBILE": "",
				"PARENTCONTACTEMAIL": "",
				"DEFAULTPARENT": 1,
				"USEPARENTADDRESS": 0,
				"PRIMARYCONTACT": 0,
				"RELATIONSHIPTYPE": 0
			},
			{
				"CONTACTPARENTGUID": "GLNITEJRNEMMMY2Y",
				"CONTACTGUID": "W2ABACKG910TM03R",
				"CONTACTNAME": "James Hetfield",
				"CONTACTPHONE": "",
				"CONTACTMOBILE": "",
				"CONTACTEMAIL": "",
				"PARENTGUID": "6IFXEASA309DOCL7",
				"PARENTCONTACTNAME": "Metallica",
				"PARENTCONTACTPHONE": "",
				"PARENTCONTACTMOBILE": "",
				"PARENTCONTACTEMAIL": "",
				"DEFAULTPARENT": 1,
				"USEPARENTADDRESS": 0,
				"PRIMARYCONTACT": 0,
				"RELATIONSHIPTYPE": 0
			}
		]
	}
} 
				

RESPONSE EXAMPLE 4 - GETDATA (Companies a person is attached to)

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"RECORDS": [{
			"CONTACTPARENTGUID": "YQAGKUK1C8QKBYLO",
			"CONTACTGUID": "MOI3P756LWCTPOMO",
			"CONTACTNAME": "Lars Ulrich",
			"CONTACTPHONE": "",
			"CONTACTMOBILE": "",
			"CONTACTEMAIL": "",
			"PARENTGUID": "6IFXEASA309DOCL7",
			"PARENTCONTACTNAME": "Metallica",
			"PARENTCONTACTPHONE": "",
			"PARENTCONTACTMOBILE": "",
			"PARENTCONTACTEMAIL": "",
			"DEFAULTPARENT": 1,
			"USEPARENTADDRESS": 0,
			"PRIMARYCONTACT": 0,
			"RELATIONSHIPTYPE": 0
		}]
	}
}
				

  Back to top

Helper Functions

This is the documentation for helper functions that act in conjunction with the v10 APIs.


AuditLog

DESCRIPTION

Returns audit logs for the last 30 days for matters, contacts, invoices, income and expenditure.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
Action Yes Only supports GetData
Filters Yes

Supported values for the LogFile filter are:

  • Matter
  • Contact
  • Invoice
  • Income
  • Expenditure
  • WorkItems


AVAILABLE FIELDS

Field Name Data Type Description
LOGDATE Date The date when the action occurred
LOGTIME Time The time when the action occurred
LOGUSER String The name of the user who performed the action
LOGTEXT String Details about the action

EXAMPLE REQUEST 1 - FILTER BY MATTERS

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "Matter"}}


EXAMPLE REQUEST 2 - FILTER BY CONTACTS

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "Contact"}}


EXAMPLE REQUEST 3 - FILTER BY INVOICES

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "Invoice"}}


EXAMPLE REQUEST 4 - FILTER BY INCOME

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "Income"}}


EXAMPLE REQUEST 5 - FILTER BY EXPENDITURE

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "Expenditure"}}


EXAMPLE REQUEST 6 - FILTER BY WORKITEMS

{"SessionToken": "HuLjO6xEAJXmDuDXh6bLyJYFZkroeX", "Action": "GetData", "Filters": {"LogFile": "WorkItems"}}


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"RECORDS": [{
				"LOGDATE": "6/08/2021",
				"LOGTIME": "8:58AM",
				"LOGUSER": "",
				"LOGTEXT": "Action=Before Change  |  Matter No=21SHA01  |  Matter Desc=BRS matter test #1  |  Client="
			},
			{
				"LOGDATE": "6/08/2021",
				"LOGTIME": "8:58AM",
				"LOGUSER": "",
				"LOGTEXT": "Action=After Change  |  Matter No=21SHA01  |  Matter Desc=BRS matter test #1  |  Client=Brett Sharman"
			},
			...
			{
				"LOGDATE": "31/08/2021",
				"LOGTIME": "2:43PM",
				"LOGUSER": "Brett Sharman",
				"LOGTEXT": "Action=Before Change  |  Matter No=100000-004  |  Matter Desc=BRS estate  |  Client="
			},
			{
				"LOGDATE": "31/08/2021",
				"LOGTIME": "2:43PM",
				"LOGUSER": "Brett Sharman",
				"LOGTEXT": "Action=After Change  |  Matter No=100000-004  |  Matter Desc=BRS estate  |  Client=Brett Sharman"
			}
		]
	}
}
				

  Back to top

CalcDebtRecoveryValues

DESCRIPTION

Receives debt recovery matter values and returns new TotalDebt, BalanceOwing, GarnisheeTotal, InterestToDate and InterestSinceDefaultJudgement values.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
DebtAmount Yes Debt Amount
DebtDueDate Yes Debt Due Date
InterestRateType Yes Interest Type
InterestRate Yes Interest Rate
InterestEndDate Yes Interest End Date
InterestToDate Yes Interest To Date
FilingFees Yes Filing Fees
ServiceFees Yes Service Fees
SolicitorsFees Yes Solicitors Fees
AmountRecovered Yes Amount Recovered
DefaultJudgementDate Yes Default Judgement Date
DJInterestRate Yes DJ Interest Rate
InterestSinceDefaultJudgement Yes Interest Since DJ
AdditionalServiceFees Yes Addit. Service Fees
FinalPaymentDate Yes Final Payment Date
TotalDebt Yes Total Debt
BalanceOwing Yes Balance Owing
GarnisheeTotal Yes Garnishee Total

EXAMPLE REQUEST

{
	"SESSIONTOKEN": "ts5ySEgtbMW4XpjPkC4ihXhWDfOTNc",
	"DEBTAMOUNT": 25000,
	"DEBTDUEDATE": "31/08/2021",
	"INTERESTRATETYPE": "Compound",
	"INTERESTRATE": 0,
	"INTERESTENDDATE": "",
	"INTERESTTODATE": 0,
	"FILINGFEES": 495,
	"SERVICEFEES": 200,
	"SOLICITORSFEES": 1300,
	"AMOUNTRECOVERED": 10000,
	"DEFAULTJUDGEMENTDATE": "",
	"DJINTERESTRATE": 0,
	"INTERESTSINCEDEFAULTJUDGEMENT": 0,
	"ADDITIONALSERVICEFEES": 300,
	"FINALPAYMENTDATE": "",
	"TOTALDEBT": 0,
	"BALANCEOWING": 0,
	"GARNISHEETOTAL": 900
}
				


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"TOTALDEBT": 26995,
		"BALANCEOWING": 16995,
		"GARNISHEETOTAL": 17295,
		"INTERESTTODATE": "0",
		"INTERESTSINCEDEFAULTJUDGEMENT": 0
	}
}
				

  Back to top

GetArchiveNumber

DESCRIPTION

Returns the next archive number to use for a firm.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID

EXAMPLE REQUEST

{"SessionToken" : "l6QfaKdPSbdyolKUCxLXP8hI41HPhV"}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"ARCHIVENUMBER" : "20632"
	}
}
				

  Back to top

GetClarionDateTime

DESCRIPTION

Returns the Clarion formatted date and/or time for a human readable date and/or time.


REQUEST PARAMETERS

Name Required Value
HumanDate No Date in a human readable format
DatePicture No Format for the input date. If no value is specified the default will be @d06b (dd/mm/yyyy)
HumanTime No Time in a human readable format
TimePicture No Format for the input time. If no value is specified the default will be @t06b (hh:mm:ssXM)

EXAMPLE REQUEST

{"HumanDate" : "18/06/2021", "HumanTime": "11:03:00AM"}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"CLARIONDATE" : 80526,
		"CLARIONTIME" : 3978001
	}
}
				

  Back to top

GetGuid

DESCRIPTION

Returns a random GUID value.


REQUEST PARAMETERS

Name Required Value
Length No The length of the string to be returned. If no length is specified the default length will be 16 characters.
Case No The case (uppercase or lowercase) of the alphabetic characters to be included in the guid. If no value is specified the default will be uppercase.

EXAMPLE REQUEST

{"Length" : 16, "Case": "Uppercase"}


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"GUID": "RHCM0CDRR3ATQBK2"
	}
}
				

  Back to top

GetHumanDateTime

DESCRIPTION

Returns the human readable date and/or time for a Clarion formatted date and/or time.


REQUEST PARAMETERS

Name Required Value
ClarionDate No Date in a Clarion format
DatePicture No Format for the output date. If no value is specified the default will be @d06b (dd/mm/yyyy)
ClarionTime No Time in a Clarion format
TimePicture No Format for the output time. If no value is specified the default will be @t06b (hh:mm:ssXM)

EXAMPLE REQUEST

{"ClarionDate": 81234, "ClarionTime": 3500000}


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"HUMANDATE": "27/05/2023",
		"HUMANTIME": "09:43:19AM"
	}
}
				

  Back to top

GetUUID

DESCRIPTION

Returns a UUID in the format 8-4-4-4-12.


REQUEST PARAMETERS

Name Required Value
Case No The case (uppercase or lowercase) of the alphabetic characters to be included in the guid. If no value is specified the default will be uppercase.

EXAMPLE REQUEST

{"Case": "Uppercase"}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"UUID" : "MFXQNGQD-5MBD-1EE2-LN6H-H0KUTIKFTOAZ"
	}
}
				

  Back to top

NetGetAddressMatches

DESCRIPTION

Returns up to 20 matches for an address or partial address.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
Address Yes Some address substring in Australia at least 6 characters long

EXAMPLE REQUEST

{"SessionToken" : "cOOhcLiceLru5jQEAhDSYiRLOdFz7w", "Address": "Crown Street, Wollongong"}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"SUGGESTIONS" : [
			{
				"COMBINED" : "Crown Street Mall,  Wollongong,  NSW, Australia",
				"UNIT" : "",
				"HOUSENUMBER" : "",
				"STREET" : "Crown Street Mall",
				"DISTRICT" : "Wollongong",
				"CITY" : "Wollongong",
				"COUNTY" : "",
				"STATE" : "NSW",
				"COUNTRY" : "Australia",
				"POSTALCODE" : "2500"
			},
			{
				"COMBINED" : "Crown St,  Wollongong,  NSW, Australia",
				"UNIT" : "",
				"HOUSENUMBER" : "",
				"STREET" : "Crown St",
				"DISTRICT" : "Wollongong",
				"CITY" : "Wollongong",
				"COUNTY" : "",
				"STATE" : "NSW",
				"COUNTRY" : "Australia",
				"POSTALCODE" : "2500"
			},
			{
				"COMBINED" : "Crown St,  West Wollongong,  NSW, Australia",
				"UNIT" : "",
				"HOUSENUMBER" : "",
				"STREET" : "Crown St",
				"DISTRICT" : "West Wollongong",
				"CITY" : "Wollongong",
				"COUNTY" : "",
				"STATE" : "NSW",
				"COUNTRY" : "Australia",
				"POSTALCODE" : "2500"
			}
		]
	}
}
				

  Back to top

NetGetMFAQRCodeURI

DESCRIPTION

Returns a QR code URI for the currently logged on user. This QR code can then be scanned by authenticator apps eg: Googe Authenticator to create a 2-Factor authentication account.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID

EXAMPLE REQUEST

{"SessionToken" : "9ObnGhhBwXYZPFhewwZydKXjwmARzR"}


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"URI": "otpauth://totp/Silq Online%3Atestuser%40silq.com.au?secret=LBDE2MRUGVCUKVCLGA4FGWSKLE&issuer=Silq Online"
	}
}
				

  Back to top

Notifications

DESCRIPTION

Performs data checks on the matter and trust data and returns details of any warnings and errors.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
Action Yes Only supports GetData

EXAMPLE REQUEST

{"SessionToken": "LPrMkhUfp60CjpTuLGDkcMeji6FFKA", "Action": "GetData"}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"RECORDS" : [
			{
				"NOTIFICATIONGUID" : "52OUQYRE6DS6I2GB",
				"IMPORTANCE" : 4,
				"DESCRIPTION" : "There are Matter Expenses potentially available to be paid as their invoices have been paid.",
				"LINKTYPE" : 4,
				"LINKCODE" : 0,
				"URL" : "",
				"HEADING" : "Matter Expenses",
				"DATEANDTIME" : "7 Sep,  3:29PM",
				"ICONNAME" : ""
			}
		]
	}
}
				

  Back to top

PrintBankingSlip

DESCRIPTION

Generates a banking slip report for the specified criteria.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
AccountGuid Yes Bank Account Guid
UseTrust Yes true/1 or false/0
BankingSlipId Yes Slip Id

EXAMPLE REQUEST

{"SessionToken" : "ogCIO7Oo3ZOhLWDseVFrt2ZDMW5Ny3","AccountGuid": "DOB6K93A08XDNOEV", "UseTrust": 1, "BankingSlipId": 250}


EXAMPLE RESPONSE

{
	"STATUS": "success",
	"CODE": "200",
	"MESSAGE": "",
	"DATA": {
		"PDFFILENAME": "C:/Dev/SILQ/Server10/web/Users/BrettTestDatabase/Reports/TrustBanking_20210921_101431.PDF"
	}
}
				

  Back to top

UserActivity

DESCRIPTION

Returns currently logged in users and login history for a firm.


REQUEST PARAMETERS

Name Required Value
SessionToken Yes Session ID
UserGuid No User Guid

EXAMPLE REQUEST 1- FILTER BY A SPECIFIC USER

{"SessionToken": "pY7LDYqDWNbgUBGsu7JgnMlZlacJk2", "Action": "GetData", "Filters": {"UserGuid": "KZ1O098GFSYTUXO3"}}


EXAMPLE REQUEST 2- RETURN DATA FOR ALL USERS

{"SessionToken": "pY7LDYqDWNbgUBGsu7JgnMlZlacJk2", "Action": "GetData", "Filters": {}}


EXAMPLE RESPONSE

{
	"STATUS" : "success",
	"CODE" : "200",
	"MESSAGE" : "",
	"DATA" : {
		"CURRENTLYLOGGEDONUSERS" : [
			{
				"USERNAME" : "Brett Sharman",
				"LOGGEDINDATE" : "13/08/2021",
				"LOGGEDINTIME" : "5:13AM"
			}
		],
		"LOGONHISTORY" : [
			{
				"USERNAME" : "Brett Sharman",
				"LOGGEDINDATE" : "13/08/2021",
				"LOGGEDINTIME" : "4:31AM",
				"LOGGEDOUTDATE" : "13/08/2021",
				"LOGGEDOUTTIME" : "5:10AM"
			},
			{
				"USERNAME" : "Brett Sharman",
				"LOGGEDINDATE" : "13/08/2021",
				"LOGGEDINTIME" : "3:35AM",
				"LOGGEDOUTDATE" : "13/08/2021",
				"LOGGEDOUTTIME" : "4:31AM"
			},
			{
				"USERNAME" : "Brett Sharman",
				"LOGGEDINDATE" : "13/08/2021",
				"LOGGEDINTIME" : "3:27AM",
				"LOGGEDOUTDATE" : "13/08/2021",
				"LOGGEDOUTTIME" : "3:35AM"
			},
			{
				"USERNAME" : "Brett Sharman",
				"LOGGEDINDATE" : "13/08/2021",
				"LOGGEDINTIME" : "12:22AM",
				"LOGGEDOUTDATE" : "13/08/2021",
				"LOGGEDOUTTIME" : "3:27AM"
			}
		]
	}
}
				

  Back to top

Support Docs

This is support team specific documentation for v10.


SILQ 10 Merge Fields

DESCRIPTION

This table contains the merge fields used by the v10 application. The search function operates across all columns and can be used to limit the rows shown. The data can also be sorted in either ascending or descending order by clicking on the colum headers.


Name Formula Description
today today() Todays Date
s-bn GetSystemValue('BarristersName') Name of the practice
s-chmbr GetSystemValue('Chambers') Chambers
s-addr1 GetSystemValue('Address1') Address 1 of the practice
s-addr2 GetSystemValue('Address2') Address2 of the practice
s-sub GetSystemValue('Suburb') Suburb of the practice
s-pc GetSystemValue('PostCode') Post Code of the practice
s-state GetSystemValue('State') State of the practice
s-paddr1 GetSystemValue('PostalAddress1') Post Address 1 of the practice
s-paddr2 GetSystemValue('PostalAddress2') Postal Address 2 of the practice
s-psub GetSystemValue('PostalSuburb') Postal Suburb of the practice
s-ppc GetSystemValue('PostalPostCode') Postal Post Code of the practice
s-pstate GetSystemValue('PostalState') Postal State of the practice
s-dx GetSystemValue('DXNumber') DX Number of the practice
s-dxsub GetSystemValue('DXSuburb') DX Suburb of the practice
s-phone1 GetSystemValue('Phone1') Phone 1 of the practice
s-fax1 GetSystemValue('Fax1') Fax 1 of the practice
s-phone2 GetSystemValue('Phone2') Phone2 of the practice
s-fax2 GetSystemValue('Fax2') Fax 2 of the practice
s-email GetSystemValue('Email') Email of the practice
s-www GetSystemValue('WWW') Web site address
s-hbr GetSystemValue('HourlyBaseRate') Hourly Base Rate
s-dbr GetSystemValue('DailyBaseRate') Daily Base Rate
s-abn GetSystemValue('ABN') ABN
m-id Mat:MatterGuid Unique Code for Matter
m-mat Mat:Matter Matter Name
m-ref Mat:Reference Matter Reference
m-note Mat:Notes Matter Notes
m-mno Mat:MatterNo Court Matter No
m-date Mat:Date Date of Start of Matter
m-bm Mat:BillingMethod Billing Method
m-rph GetMatterRatePerHour() Rate per hour for this matter
m-rpd GetMatterRatePerDay() Rate per day for this matter
m-fr Mat:FixedRateIncGST Amount for fixed rate matter
m-tv Mat:TotalValueIncGST Total Value of Work in Progress Items inc GST
m-iv Mat:InvoicedValueIncGST Total value of invoices for this matter inc GST
m-rv Mat:ReceivedValueIncGST Total Amount recieved for this matter
f-fn CON:ContactName Name of firm
f-addr1 CON:Address1 Address 1 of firm
f-addr2 CON:Address2 Address 2 of firm
f-sub CON:Suburb Suburb of firm
f-state CON:State State of firm
f-pc CON:PostCode Post Code of firm
f-dx CON:DX DX No of firm
f-dxsub CON:DXSuburb DX Suburb of firm
f-paddr1 CON:PostalAddress1 Postal Address 1 of firm
f-paddr2 CON:PostalAddress2 Postal Address 2 of firm
f-psub CON:PostalSuburb Postal Suburb of firm
f-pstate CON:PostalState The postal state of the firm
f-ppc CON:PostalPostcode Postal Post Code of firm
f-phone CON:Phone Phone Number of firm
f-fax CON:Fax Fax Number of firm
f-email CON:Email Email of firm
f-acn CON:ACN ACN of firm
f-abn CON:ABN ABN of firm
w-price Choose(WKI:InvoiceGuid~='',CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGSTCharged,WKI:PriceCharged),CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGST,WKI:Price)) Price of WIP/Disbursement Item
c-date GetFormattedChronoDate(CHR:DateFrom,CHR:TimeFrom,CHR:DateTo,CHR:TimeTo,CHR:Format,'@d8') Date and Time of Chronology Item
c-top CHR:Topic Topic of Chronology Item
c-priv FormatField(CHR:Privileged,'YesNo','') Privileged Flag of Chronology Item
c-bpn CHR:BriefPageNo Brief Page Number of Chronology Item
c-ref CHR:Reference Reference of Chronology Item
c-com CHR:Comment Comment of Chronology Item
c-note FormatField(CHR:AdditionalText,'Text',CHR:MatterGuid) Details of Chronology Item
a-auth AUT:Authority Authority Name
a-cit AUT:Citation Citation for the Authority
w-date WKI:ItemDate Date of WIP/Disbursement Item
w-qty WKI:Quantity Quantity of WIP/Disbursement Item
w-gst WKI:GSTCharged GST of WIP/Disbursement Item
w-qtyp FormatField(WKI:QuantityType,'QuantityType','') Quantity Type of WIP/Disbursement Item (Hours/Days/etc)
w-inv INV:InvoiceCode The Invoice the WIP/Disbursement Item has been allocated to
w-type FormatField(WKI:ItemType,'ItemType','') Type of WIP/Disbursement Item (WIP/Disbursement)
i-matid INV:MatterGuid ID of the Matter for the Invoice
i-id INV:InvoiceCode Unique ID for the Invoice
i-date INV:InvoiceDate Date for the Invoice
i-due INV:DueDate Date Due for the Invoice
i-prnt INV:DatePrinted Date the Invoice was printed
i-total CHOOSE(Mat:GSTType=GST:Inclusive,INV:InvoiceTotal+INV:GST,INV:InvoiceTotal) The Total Value of the Invoice
i-gst INV:GST The Total GST for the Invoice
i-pay INV:InvoiceTotal+INV:GST The total amount payable for the invoice
i-rec INV:AmountPaidIncGST The total amount received for this invoice
i-out INV:AmountOutstandingIncGST The total amount currently outstanding for this invoice
a-note FormatField(AUT:Reference,'Text','') The reference for the authority
ei-serv ESI:Service The description of the service for the Estimate Item
ei-qty FormatQuantity(ESI:ItemType,ESI:QuantityFrom,ESI:QuantityTypeFrom,ESI:FeeType,'') The quanity of the service for the Estimate Item
ei-type FormatField(ESI:QuantityTypeFrom,'QuantityType','') The Quantity Type of the Estimate Item
ei-price ESI:PriceFrom The value of the Estimate Item
r-id INC:IncomeCode The ID of the Receipt
r-date INC:IncomeDate The Date of the Receipt
r-matid INC:MatterGuid The ID of the Matter for the Receipt
r-type INC:IncomeType The type of the Payment (Cash/Cheque/etc)
ra-recid INC:IncomeCode The ID of the Receipt for the Receipt Allocation
ra-invid CHOOSE(RCA:InvoiceGuid~='',FORMAT(INV:InvoiceCode,@n08),'Credit') The ID of the Invoice for this Receipt Allocation
ra-amt RCA:Amount The Amount allocated to an invoice for Receipt Allocation
w-note FormatField(WKI:AdditionalText,'Text',WKI:MatterGuid) Description of WIP/Disbursement
m-est MAT:EstimateFromTotalExGST Deprecated
m-active FormatField(MAT:Active,'YesNo','') This indicates if the matter is still active or not
mc-for PER:ContactName The formal name of the matter contact
mc-sal PER:Salutation The salutation for the contact solicitor on this matter
mc-position PER:Title The position of the contact solicitor on this matter
mc-phone PER:Phone The phone number for the contact solicitor on this matter
mc-fax PER:Fax The fax number for the contact solicitor on this matter
w-qty2 FormatQuantity(WKI:ItemType,WKI:Quantity,WKI:QuantityType,WKI:FeeType,'') Formatted Quantity and Type of WIP/Disbursement
count-wip Count:WIP Count of the number of items in a Multi:WIP
count-disb Count:Disb Count of the number of items in a Multi:Disb
count-inv Count:Invoice Count of the number of items in a Multi:Invoice
count-auth Count:Auth Count of the number of items in a Multi:Auth
count-chrono Count:Chrono Count of the number of items in a Multi:Chrono
count-estitem Count:EstItem Count of the number of items in a Multi:EstItem
sum-w-gst Sum:WIP:GST The total of the gst for fees printed in the document
sum-w-price CHOOSE(Mat:GSTType=GST:Inclusive,Sum:WIP:PriceIncGST,Sum:WIP:Price) The total of the price for fees printed in the document
sum-d-gst Sum:Disb:GST The total of the gst for disbursements in the document
sum-d-price CHOOSE(Mat:GSTType=GST:Inclusive,Sum:Disb:PriceIncGST,Sum:Disb:Price) The total of the price for disbursements in the document
sum-i-gst Sum:Inv:GST The total of the gst for invoices printed in the document
sum-i-total Sum:Inv:Total The total of the invoices (ex-gst) printed in the document
sum-i-paid Sum:Inv:Paid The total paid on the invoices printed in the document
sum-ei-price Sum:Est:Price The total of the estimates printed in the document
m-fad Mat:FeeAgreementDate Date that the fee agreement was sent for this matter
sum-i-pay Sum:Inv:GST + Sum:Inv:Total The total of the payable amounts printed in the document
sum-i-out Sum:Inv:GST + Sum:Inv:Total - Sum:Inv:Paid - Sum:Inv:WriteOffInc The total of the outstanding amount for invoices printed
mc-mob PER:Mobile The Mobile phone number of the contact for a Matter
m-rpd2 GetMatterRatePerDay() / 2 Half the rate per day for this matter
m-gstinc FormatField(Mat:GSTType=GST:Inclusive,'GSTInclusive','') Indicates if this matter is being done as GST Inclusive
ei-pricegst ESI:PriceIncGSTFrom The value of the Estimate Item including GST
m-estgst MAT:EstimateFromTotalIncGST Deprecated
a-cmnt FormatField(AUT:Comment,'Text','') The extra comments associated withe the authority
f-www CON:WebAddress The web address of the firm
mc-email PER:Email The email address for the contact solicitor on this matter
i-cmnt INV:Comment The additional comments for an invoice
r-alloc ReceiptAllocations(INC:IncomeGuid) A Description of what allocations were made for the receipt
s-fastmnt GetSystemValue('FeeAgreementStatement') The legal statement for an invoice specifically for the Fee
s-stmnt2 GetSystemValue('Statement2') The second legal statment to be put on an invoice
s-stmnt3 GetSystemValue('Statement3') The third legal statement to be put on an invoice
s-stmnt4 GetSystemValue('Statement4') The fourth legal statement to be put on an invoice
s-stmnt5 GetSystemValue('Statement5') The fifth legal statement to be put on an invoice
w-fecode WKI:FeeEarner The short code for the fee earner associated with the time e
sum-r-total Sum:Rec:Total The total of the receipts in the document
i-age TODAY() - INV:InvoiceDate The Age of the Invoice
a-www AUT:WebAddress The web site for the authority
c-wit CHR:Witnesses The witnesses for a chronology item
c-agrd CHR:EventAgreed Whether the event it agreed
m-mattype MAT:MatterType The Type of Matter - Civil / Criminal etc
m-court MAT:Court The Court that the matter is being heard in
m-div MAT:Division The Division of the Court that the matter is being heard in
m-client MAT:ClientName Only relevant to barrister. Use m-cli
m-clstat MCV:ClientStatus Whether the client is a the Defendant or Plaintiff
i-isintinv CHOOSE(INV:ParentInvoiceGuid~='',1,0) Determines whether it is an interest invoice
i-int INV:Interest The amount of interest that has been added to this invoice
i-payint INV:InvoiceTotal+INV:GST+INV:Interest Amount Payable including Interest
i-recint INV:AmountPaidIncGST+INV:InterestPaid Amount Received including Interest
sum-i-outint Sum:Inv:GST + Sum:Inv:Total - Sum:Inv:Paid + Sum:Inv:Interest - Sum:Inv:InterestPaid - Sum:Inv:WriteOffInc The sum of the amount outstanding including interest
sum-i-paidint Sum:Inv:Paid + Sum:Int:InterestPaid The total paid on invoice printed including interest
sum-i-int Sum:Inv:Interest The total of all the interest included in the invoices
i-intrec INV:InterestPaid The amount of interest that has been received for the invoic
i-intout INV:Interest - INV:InterestPaid The amount of interest on the invoice that hasn't been paid
sum-i-intout Sum:Inv:Interest - Sum:Inv:InterestPaid The total amount of interest unpaid for all the invoices
sum-w-days Sum:WIP:Days The total number of days on Time Entries (excluding hours)
sum-w-hrs Sum:WIP:Hours The total number of hours on a Time Entries (excluding days)
sum-w-disc Sum:WIP:Discounts Total amount discounted on Time Entries
sum-w-fxd Sum:WIP:Fixed*INV:ForeignCurrencyRate Total amount of fixed amount Time Entries
f-active FormatField(CON:Active,'YesNo','') Determines if the firm is active
c-active FormatField(PER:Active,'YesNo','') Determines if the contact is active
m-list Mat:CourtList The List the matter is on
m-reg Mat:Registry The Court Registry for the matter
r-amt INC:Amount+INC:GST The total amount of the receipt
r-amtexgst INC:Amount The amount of the receipt less the GST
f-position CON:Title The position of the firm
f-phone2 CON:Phone2 Second phone number of firm
f-fax2 CON:Fax2 The second fax number of the firm
mc-abn PER:ABN The ABN of the matter contact
mc-acn PER:ACN The ACN of the matter contact
mc-active FormatField(PER:Active,'YesNo','') Determines if the matter contact is active
mc-addr1 PER:Address1 Address 1 of matter contact
mc-addr2 PER:Address2 Address 2 of contact
mc-dx PER:DX DX No of matter contact
mc-dxsub PER:DXSuburb DX Suburb of matter contact
mc-fax2 PER:Fax2 The second fax number of the matter contact
mc-paddr1 PER:PostalAddress1 Postal Address 1 of the matter contact
mc-paddr2 PER:PostalAddress2 Postal Address 2 of the matter contact
mc-pc PER:PostCode Postcode of the matter contact
mc-phone2 PER:Phone2 The second phone of the matter contact
mc-ppc PER:PostalPostCode Postal postcode of the matter contact
mc-pstate PER:PostalState Postal state of the matter contact
mc-psub PER:PostalSuburb Postal suburb of the matter contact
mc-state PER:State State of the matter contact
mc-sub PER:Suburb Suburb of the matter contact
mc-www PER:WebAddress Web address of the matter contact
m-csal PER:Salutation Matter contact salutation
m-cfor PER:ContactName Matter contact formal name
m-cphone PER:Phone Matter contact phone
m-cfax PER:Fax Matter contact fax
m-ctit PER:Title Matter contact title
m-cmob PER:Mobile Matter contact mobile
m-cemail PER:Email Matter contact Email
ei-gst ESI:GSTFrom The GST on the Estimate Item
i-outint INV:AmountOutstandingIncGST + INV:Interest - INV:InterestPaid Total Outstanding including interest charges
count-matplain Count:MatPlain Count of the number of matter plaintiffs
count-matdef Count:MatDef Count of the number of defendants
count-matcon Count:MatCon Count of the number of matter contacts
count-matxclaim Count:MatXClaim Count of the number of cross claimants
count-matxdef Count:MatXDef Count of the number of cross defendants
m-df1 GetFirstMatterContactName(MAT:MatterGuid,2) Name of the first Defendant for the matter
m-pl1 GetFirstMatterContactName(MAT:MatterGuid,1) Name of the first Plaintiff
m-xcl1 GetFirstMatterContactName(MAT:MatterGuid,3) Name of the first cross claimant
m-xdf1 GetFirstMatterContactName(MAT:MatterGuid,4) Name of the first cross defendant
mcs-abn SOL:ABN The ABN of the matter contact solicitor
mcs-acn SOL:ACN The ACN of the matter contact solicitor
mcs-active Format(SOL:Active,'YesNo','') Determines if the matter contact solicitor is active
mcs-addr1 SOL:Address1 Address1 of the matter contact solicitor
mcs-addr2 SOL:Address2 Address 2 of the matter contact solicitor
mcs-pc SOL:PostCode Postcode of the matter contact solicitor
mcs-dx SOL:DX DX of the matter contact solicitor
mcs-dxsub SOL:DXSuburb DX Suburb of the matter contact solicitor
mcs-email SOL:Email The email of the matter contact solicitor
mcs-fax SOL:Fax The fax of the matter contact solicitor
mcs-fax2 SOL:Fax2 The 2nd fax of the matter contact solicitor
mcs-for SOL:ContactName The formal name of the matter contact solicitor
mcs-mob SOL:Mobile The mobile phone of the matter contact solicitor
mcs-paddr1 SOL:PostalAddress1 Postal Address 1 of the matter contact solicitor
mcs-paddr2 SOL:PostalAddress2 Postal Address 2 of the matter contact solicitor
mcs-phone SOL:Phone The phone of the matter contact solicitor
mcs-phone2 SOL:Phone2 Phone 2 of the matter contact solicitor
mcs-ppc SOL:PostalPostCode The postal postcode of the matter contact solicitor
mcs-pstate SOL:PostalState Postal State of the matter contact solicitor
mcs-psub SOL:PostalSuburb Postal suburb of the matter contact solicitor
mcs-sal SOL:Salutation The salutation of the matter contact solicitor
mcs-state SOL:State The state of the matter contact solicitor
mcs-sub SOL:Suburb The suburb of the matter contact solicitor
mcs-tit SOL:Title The title of the matter contact solicitor
mcs-www SOL:WebAddress The web address of the matter contact solicitor
mcs-praccert SOL:PracticingCertificateNo The practicising certificate number of the solicitor
mc-praccert PER:PracticingCertificateNo The practicing certificate of the matter contact
f-praccert CON:PracticingCertificateNo The practicing certificate of the firm
m-short MAT:ShortName The SILQ matter number of the matter
m-isgstinc CHOOSE(MAT:GSTType=GST:Inclusive,1,0) The matter is GST inclusive
f-bestpostaladdr GetContactBestAddress() The best address for firm, DX then, Postal then street
ei-gstmax ESI:GSTTo The Maximum GST on the Estimate Item
ei-pricemax ESI:PriceTo The Maximum Price on the Estimate Item
ei-qtymax FormatQuantity(ESI:ItemType,ESI:QuantityTo,ESI:QuantityTypeTo,ESI:FeeType,'') The maximum quantity of the service for the Estimate item
ei-typemax FormatField(ESI:QuantityTypeTo,'QuantityType','') The Maximum Quantity Type of the Estimate Item
m-estmax MAT:EstimateToTotalExGST Deprecated
m-estgstmax MAT:EstimateToTotalIncGST Deprecated
ei-pricegstmax ESI:PriceIncGSTTo The maximim value of the Estimate Item including GST
prompt PromptForEntry('1','@n$12.2','This is what you need to enter') The is what you need to enter!!!!
f-brthcntry CON:CountryOfBirth The country of birth for the firm
f-brthtwn CON:TownOfBirth Firms Birth town
f-mob CON:Mobile Firms mobile phone number
f-dob CON:DateOfBirth Firms date of birth
f-prevfamname CON:OtherFamilyName Firms previous family name
f-prevgivname CON:OtherGivenNames Firms other given name
f-famname CON:FamilyName Firm family name
f-givname CON:GivenNames Firms given name
f-prevname FormatField(CON:KnownByOtherName,'YesNo','') Whether or not the firm had a previous name
f-titlestandard FormatField(CON:NameTitle,'TitleStandard','') Firms Title only showing Mr/Mrs/Miss/Ms
f-titleother FormatField(CON:NameTitle,'TitleOther','') Firms Title excluding Mr/Mrs/Miss/Ms
f-prevnamereason CON:ReasonForChange Reason the firm changed thier name
f-gender FormatField(CON:Gender,'Gender','') Firm gender
f-citizcntry CON:PresentCountryOfCitizenship The firms present country of citizenship
f-prevcntryres CON:PreviousCountryOfResidence The firms previous country of residence
f-permresentry CON:DateFirstEnteredWithPermVisa The date the firm first entered on thier perm res visa
f-country CON:Country The country for the street address
f-getsubrecs GetContactSubRecords(CON:ContactGuid) Fetch associated records for a firm
s-rph GetSystemValue('HourlyBaseRate') Default hourly rate for the whole system
s-rpd GetSystemValue('DailyBaseRate') Default daily rate for the system
s-isgstinc CHOOSE(GetSystemValue('GSTType')=GST:Inclusive,1,0) The default rates are GST Inclusive
f-sal CON:Salutation Salutation of the firm
f-chrdet CON:CharacterDetails Details of any if any character questions were answered yes
fmt-yn-1 SetFormattingStyle('YesNo',1) Sets how Yes/No fields to be "no/Yes "
f-drivlic CON:LicenceNo Firms Driver's licence
f-drivliccntry CON:LicenceCountry Country of the drivers licence
f-natid CON:NationalIdentityNo National identity number
f-natidcntry CON:NationalIdentityCountry The country of the National Id
f-pcountry CON:PostalCountry The country of the postal address
mc-country PER:Country The country of the matter contact
mc-pcountry PER:PostalCountry The postal country of the matter contact
m-rphgst CHOOSE(Mat:GSTType=GST:Inclusive,GetMatterRatePerHour(),GetMatterRatePerHour() * (1+(GST:Rate()/100))) The rate per hour including GST
m-compdate MAT:CompletedDate The date the matter was completed
m-rph10 GetMatterRatePerHour()/10 Unit Rate - 6 minute rate
w-cmnt WKI:Comment Notes for the time entry
mc-plainpos GetPositionDesc(Count:MatPlain) Matter Plaintiff Position
mc-defpos GetPositionDesc(Count:MatDef) Matter Defendant Position
mc-xclaimpos GetPositionDesc(Count:MatXClaim) Matter Cross Claimant Position
mc-xdefpos GetPositionDesc(Count:MatXDef) Matter Cross Defendant Position
w-priceex Choose(WKI:InvoiceGuid~='',WKI:PriceCharged,WKI:Price) Ex GST Price of WIP/Disbursement Item
i-totalex INV:InvoiceTotal The GST Exclusive Total Value of the Invoice
m-estminexgst MAT:EstimateFromTotalExGST Minimum Estimate Excluding GST
m-estminincgst MAT:EstimateFromTotalIncGST Minimum Estimate Including GST
m-estmingst MAT:EstimateFromTotalIncGST - MAT:EstimateFromTotalExGST GST on the Minimum Estimate
m-estmaxexgst MAT:EstimateToTotalExGST Maximum Estimate Excluding GST
m-estmaxincgst MAT:EstimateToTotalIncGST Maximum Estimate Including GST
m-estmaxgst MAT:EstimateToTotalIncGST- MAT:EstimateToTotalExGST GST on the Maximum Estimate
count-mat2def Count:MatDef > 2 Is there mroe than 2 defendants on the matter
i-detailshtml GetInvoiceItems(INV:InvoiceGuid,1) The WIP and disubursements for the selected invoice
i-details GetInvoiceItems(INV:InvoiceGuid,0) The WIP and disubursements for the selected invoice
w-tod WKI:ItemTime Time of the Time Entry
x-date EXP:Date_ Date of the Expenditure
x-type EXP:ExpenditureType Type of the Expenditure
x-chq EXP:ChequeNo Cheque No used for Expenditure
x-payee EXP:Payee Payee of the Expenditure
x-amt EXP:Amount Amount (Ex-GST) of the Expenditure
x-gst EXP:GST GST of the Expenditure
x-note EXP:Note Description of the Expenditure
min-w-date Min:WIP:Date Start date of WIP
max-w-date Max:WIP:Date End date of WIP
min-d-date Min:Disb:Date Start date of Disbursements
max-d-date Max:Disb:Date End date of Disbursements
min-wd-date Min:WIPDisb:Date Start date of WIP and Disbusements
max-wd-date Max:WIPDisb:Date End date of WIP and Disbusements
min-i-date Min:Inv:Date Start date of Invoices
max-i-date Max:Inv:Date End date of Invoices
w-priceinc Choose(WKI:InvoiceGuid~='',WKI:PriceIncGSTCharged,WKI:PriceIncGST) Inc GST Price of WIP/Disbursement Item
sum-d-priceinc Sum:Disb:PriceIncGST Total of the Inc GST Price for disbursements in the document
sum-d-priceex Sum:Disb:Price Total of the Ex GST Price for disbusements in the document
sum-w-priceex Sum:WIP:Price The total of the Ex GST Price for fees printed in the doc
sum-w-priceinc Sum:WIP:PriceIncGST The total of the Inc GST Price for fees printed in the doc
sum-w-pricend Sum:WIP:TotalNoDisc The total of Fees excluding any discount items
sum-w-pricendex Sum:WIP:TotalNoDiscEx The Ex-GST total of Fees excluding any discounts
sum-w-pricendinc Sum:WIP:TotalNoDiscInc The Inc-GST total of Fees excluding any discounts
sum-w-discex Sum:WIP:DiscountsEx The Ex-GST total amount discounted on Time Entries
sum-w-discinc Sum:WIP:DiscountsInc The Inc GST total amount discounted on Time Entries
sum-w-gstd Sum:WIP:GSTDisc The total of the gst for discounts
sum-w-gstnd Sum:WIP:GSTNoDisc The total of the gst for undiscounted fees
i-paynd INV:InvoiceTotal+INV:GST+INV:Interest+Sum:WIP:DiscountsInc The undiscounted amount for an invoice
w-endtime GetEndTime(WKI:ItemTime,WKI:QuantityType,WKI:Quantity) The end time of the time entry
fe-code USR:UserId Fee Earner Id
fe-user USR:UserName The username of the Fee Earner
fe-name USR:FullName The full name of the Fee Earner
fe-rph Choose(RAT:UserId = USR:UserId,RAT:RatePerHour,USR:RatePerHour) The default rate per hour for the fee earner
fe-rpd Choose(RAT:UserId = USR:UserId,RAT:RatePerDay,USR:RatePerDay) The default rate per day for the fee earner
fe-ph1 USR:Phone1 The phone 1 of the fee earner
fe-ph2 USR:Phone2 The phone 2 of the fee earner
fe-fax1 USR:Fax1 The fax 1 of the fee earner
fe-fax2 USR:Fax2 The fax 2 of the fee earner
fe-mob USR:Mobile The mobile of the fee earner
fe-email USR:Email The email of the fee earner
ss-units WKI:GST The total units for the fee earner on the invoice
ss-days WKI:Price The total days for the fee earner on the invoice
ss-hours WKI:PriceIncGST The total hours for the fee earner on the invoice
ss-gst WKI:GSTCharged The total GST for the fee earner on the invoice
ss-price WKI:PriceCharged The total Ex-GST amount for the fee earner on the invoice
ss-priceinc WKI:PriceIncGSTCharged The total Inc-GST amount for the fee earner on the invoice
sum-w-units Sum:WIP:Units The total number of units on a Time Entries (excluding days)
c-doc CHR:DOCUMENTNAME Document name associated with the chronology item
ei-order ESI:Order Estimate Order
f-title CON:NAMETITLE Firms title
f-letters CON:NAMELETTERS Firms "letters" behind thier name
f-knownbyothername FormatField(CON:KNOWNBYOTHERNAME,'YesNo','') Firm has been known by another name
f-maritalstatus CON:MARITALSTATUS Firms marital status
f-numdeps CON:NUMBEROFDEPENDANTS Number of dependants for the firm
f-occ CON:OCCUPATION Firms occupations
f-dateofdeath CON:DATEOFDEATH Firms date of death
f-causeofdeath CON:CAUSEOFDEATH Firms cause of death
f-skypeusername CON:SKYPEUSERNAME Firms Skype username
f-messengerusername CON:MESSENGERUSERNAME Firms Messenger Username
f-tfn CON:TFN Firms Tax File number
f-sophisticated FormatField(CON:SOPHISTICATEDCLIENT,'YesNo','') Is the firm a sophisticated client
mc-title PER:NAMETITLE Contacts title
mc-givennames PER:GIVENNAMES Contacts given name
mc-familyname PER:FAMILYNAME Contacts family name
mc-nameletters PER:NAMELETTERS Contacts "letters" behind thier name
mc-knownbyothername FormatField(PER:KNOWNBYOTHERNAME,'YesNo','') Contact has been known by another name
mc-otherfamilyname PER:OTHERFAMILYNAME Contacts other family name
mc-othergivennames PER:OTHERGIVENNAMES Contacts other given names
mc-reasonforchange PER:REASONFORCHANGE The reason the contact changed thier name
mc-maritalstatus PER:MARITALSTATUS Contacts marital status
mc-numdep PER:NUMBEROFDEPENDANTS Contacts number of dependants
mc-occupation PER:OCCUPATION Contacts occupation
mc-gender FormatField(PER:Gender,'Gender','') Contacts gender
mc-dateofbirth PER:DATEOFBIRTH Contacts Date of birth
mc-townofbirth PER:TOWNOFBIRTH Contacts town of birth
mc-countryofbirth PER:COUNTRYOFBIRTH Contacts country of birth
mc-dateofdeath PER:DATEOFDEATH Contacts date of death
mc-causeofdeath PER:CAUSEOFDEATH Contacts cause of death
mc-skypeusername PER:SKYPEUSERNAME Contacts skype username
mc-messengerusername PER:MESSENGERUSERNAME Contacts messenger username
mc-tfn PER:TFN Contacts Tax File Number
mc-licenceno PER:LICENCENO Contacts licence no
mc-licencecountry PER:LICENCECOUNTRY Country licence was issued
mc-nationalidentityno PER:NATIONALIDENTITYNO National identity number
mc-nationalidentitycountry PER:NATIONALIDENTITYCOUNTRY National identity country
mc-sophisticatedclient FormatField(PER:SOPHISTICATEDCLIENT,'YesNo','') Is the contact a sophiscated client
i-amountpaidexgst INV:AMOUNTPAIDEXGST Amount paid excluding GST
i-amountwrittenoffexgst INV:AMOUNTWRITTENOFFEXGST Amount written off excluding GST
i-amountwrittenoffincgst INV:AMOUNTWRITTENOFFINCGST Amount written off including GST
i-amountoutstandingexgst INV:AMOUNTOUTSTANDINGEXGST Amount oustanding excluding GST
m-fixedrateexgst MAT:FIXEDRATEEXGST Fixed rate for the matter
m-visatype MI:VISATYPE Visa type
m-visastatus MI:VISASTATUS Visa status
m-anticipateddateofentry MI:ANTICIPATEDDATEOFENTRY Anticipated date of entry
m-valueofassets MI:VALUEOFASSETS Value of assets
m-estategrossvalue ME:TotalAssets Gross value of estate - duplicate of me-totalassets
m-estatenetvalue ME:ESTATENETVALUE Net value of estate
m-receivedvalueexgst MAT:RECEIVEDVALUEEXGST Received value excluding GST
m-receivedvalueincgst MAT:RECEIVEDVALUEINCGST Received value including GST
m-writtenoffvalueexgst MAT:WRITTENOFFVALUEEXGST Written off value excluding GST
m-writtenoffvalueincgst MAT:WRITTENOFFVALUEINCGST Written off value including GST
m-invoicedvalueexgst MAT:INVOICEDVALUEEXGST Invoiced value excluding GST
m-invoicedvalueincgst MAT:INVOICEDVALUEINCGST Invoiced value including GST
m-unbilledvalueexgst MAT:UNBILLEDVALUEEXGST Unbilled value excluding GST
m-unbilledvalueincgst MAT:UNBILLEDVALUEINCGST Unbilled value including GST
m-totalvalueexgst MAT:TOTALVALUEEXGST Total value excluding GST
m-totalvalueincgst MAT:TOTALVALUEINCGST Total value including GST
m-outstandingvalueexgst MAT:OUTSTANDINGVALUEEXGST Outstanding amount excluding GST
m-outstandingvalueincgst MAT:OUTSTANDINGVALUEINCGST Outstanding amount including GST
mc-relationship MTC:RELATIONSHIP Contact relationship
mc-shareofestate MTC:SHAREOFESTATE Contact's share of the estate
r-payee INC:PAYEE Receipt payee
r-gst INC:GST Receipt GST
s-country GetSystemValue('COUNTRY') Country of the practice
s-currencysymbol GetSystemValue('CURRENCYSYMBOL') Current symbol used in the system
s-unitsperhour GetSystemValue('UNITSPERHOUR') Number of units per hour
sum-i-writeoffex Sum:Inv:WriteOffEx The total written off amount (ex-gst) in the document
sum-i-writeoffinc Sum:Inv:WriteOffInc The total written off amount (inc-gst) in the document
m-rpdgst CHOOSE(Mat:GSTType=GST:Inclusive,GetMatterRatePerDay(),GetMatterRatePerDay() * (1+(GST:Rate()/100))) The rate per day including GST
m-rpu GetMatterRatePerHour()/GetSystemValue('UnitsPerHour') The rate per unit
m-rpugst CHOOSE(Mat:GSTType=GST:Inclusive,MAT:RatePerHour/GetSystemValue('UnitsPerHour'),GetMatterRatePerHour()/GetSystemValue('UnitsPerHour') * (1+(GST:Rate()/100))) The rate per unit including GST
count-matapplic Count:MatApplic Count of the number of items in a Multi:MatApplic
count-matresp Count:MatResp Count of the number of items in a Multi:MatResp
count-matxapplic Count:MatXApplic Count of the number of items in a Multi:MatApplic
count-matxresp Count:MatXResp Count of the number of items in a Multi:MatXResp
count-matappel Count:Appel Count of the number of items in a Multi:MatAppel
count-matxappel Count:MatXAppel Count of the number of items in a Multi:MatXAppel
count-matexec Count:MatExec Count of the number of items in a Multi:MatExec
count-matbene Count:MatBene Count of the number of items in a Multi:MatBene
count-matrelate Count:MatRelate Count of the number of items in a Multi:MatRelate
m-applic1 GetFirstMatterContactName(MAT:MatterGuid,5) Name of the first applicant
m-resp1 GetFirstMatterContactName(MAT:MatterGuid,6) Name of the first respondent
m-appel1 GetFirstMatterContactName(MAT:MatterGuid,9) Name of the first appelant
m-xappel1 GetFirstMatterContactName(MAT:MatterGuid,10) Name of the first cross appelant
m-exec1 GetFirstMatterContactName(MAT:MatterGuid,11) Name of the first executor
m-bene1 GetFirstMatterContactName(MAT:MatterGuid,12) Name of the first beneficiary
m-relate1 GetFirstMatterContactName(MAT:MatterGuid,13) Name of the first related person
m-xapplic1 GetFirstMatterContactName(MAT:MatterGuid,7) Name of the first cross applicant
m-xresp1 GetFirstMatterContactName(MAT:MatterGuid,8) Name of the first cross respondant
mc-relation MTC:Relationship The relationship of the person to the matter
mc-estshare MTC:ShareOfEstate The percentage share of the estate for this contact
m-corres GetMatterContactDetail(MAT:MatterGuid,0,?,?) Matter Correspondant detail m-corres(Position,Field)
m-plain GetMatterContactDetail(MAT:MatterGuid,1,?,?) Matter Plaintiff detail m-plain(Position,Field)
m-def GetMatterContactDetail(MAT:MatterGuid,2,?,?) Matter Defendant detail m-def(Position,Field)
m-claim GetMatterContactDetail(MAT:MatterGuid,3,?,?) Matter Claimant detail m-claim(Position,Field)
m-xdef GetMatterContactDetail(MAT:MatterGuid,4,?,?) Matter Cross Defendant detail m-xdef(Position,Field)
m-applic GetMatterContactDetail(MAT:MatterGuid,5,?,?) Matter Applicant detail m-applic(Position,Field)
m-resp GetMatterContactDetail(MAT:MatterGuid,6,?,?) Matter Responent detail m-resp(Position,Field)
m-xapplic GetMatterContactDetail(MAT:MatterGuid,7,?,?) Matter Cross Applicant detail m-xapplic(Position,Field)
m-xresp GetMatterContactDetail(MAT:MatterGuid,8,?,?) Matter Cross Respondant detail m-xresp(Position,Field)
m-appel GetMatterContactDetail(MAT:MatterGuid,9,?,?) Matter Appelant detail m-appel(Position,Field)
m-xappel GetMatterContactDetail(MAT:MatterGuid,10,?,?) Matter Cross Appelant detail m-xappel(Position,Field)
m-exec GetMatterContactDetail(MAT:MatterGuid,11,?,?) Matter Executor detail m-exec(Position,Field)
m-bene GetMatterContactDetail(MAT:MatterGuid,12,?,?) Matter Beneficiary detail m-bene(Position,Field)
m-relate GetMatterContactDetail(MAT:MatterGuid,13,?,?) Matter Related Person detail m-relate(Position,Field)
ei-itemtype FormatField(ESI:ItemType,'ItemType','') Estimate Item Type
ei-fecode ESI:FeeEarner The short code for the fee earner associated with the estima
m-isgstfree CHOOSE(MAT:GSTType=GST:Free,1,0) Indicates if the matter is Free
ir-date IR:EffectiveDate Effective date for the interest rate
ir-rate IR:InterestRate The interest rate
ap-date APT:AppointmentDate The date of the appointment
ap-enddate APT:AppointmentEndDate The end date of the appointment
ap-time APT:AppointmentTime The start time of the appointment
ap-allday APT:AllDayEvent Is the appointment an all day event
ap-subj APT:Subject The subject of the appointment
ap-locat APT:Location The location of the appointment
ap-type APT:AppointmentType What type of appointment is it
ap-cat APT:Category The category of the appointment
m-purch GetMatterContactDetail(MAT:MatterGuid,14,?,?) Matter Purchaser detail m-purch(Position,Field)
m-purchsol GetMatterContactDetail(MAT:MatterGuid,15,?,?) Deprecated
m-vend GetMatterContactDetail(MAT:MatterGuid,16,?,?) Matter Vendor detail m-vend(Position,Field)
m-vendsol GetMatterContactDetail(MAT:MatterGuid,17,?,?) Deprecated
m-bank GetMatterContactDetail(MAT:MatterGuid,18,?,?) Matter Bank detail m-bank(Position,Field)
m-broker GetMatterContactDetail(MAT:MatterGuid,19,?,?) Matter Broker detail m-broker(Position,Field)
m-agent GetMatterContactDetail(MAT:MatterGuid,20,?,?) Matter Agent detail m-agent(Position,Field)
m-strata GetMatterContactDetail(MAT:MatterGuid,21,?,?) Matter Strata manager detail m-strata(Position,Field)
m-diac GetMatterContactDetail(MAT:MatterGuid,22,?,?) Matter DIAC Officer detail m-diac(Position,Field)
m-employer GetMatterContactDetail(MAT:MatterGuid,23,?,?) Matter Employer detail m-employer(Position,Field)
m-spons GetMatterContactDetail(MAT:MatterGuid,24,?,?) Matter Sponsor detail m-spons(Position,Field)
m-uni GetMatterContactDetail(MAT:MatterGuid,25,?,?) Matter University detail m-uni(Position,Field)
m-owncorpsol GetMatterContactDetail(MAT:MatterGuid,26,?,?) Matter Owners Corp Sol detail m-owncorpsol(Position,Field)
m-owner GetMatterContactDetail(MAT:MatterGuid,27,?,?) Property Owner detail m-owner(Position,Field)
m-tenant GetMatterContactDetail(MAT:MatterGuid,28,?,?) Matter Tenant detail m-tenant(Position,Field)
m-ownersol GetMatterContactDetail(MAT:MatterGuid,29,?,?) Deprecated
m-childguard GetMatterContactDetail(MAT:MatterGuid,30,?,?) Matter Childs Guardian detail m-childguard(Position,Field)
m-endguard GetMatterContactDetail(MAT:MatterGuid,31,?,?) Matter Enduring Guardian detail m-endguard(Position,Field)
m-clisource Mat:ClientSource Matter client source
m-lodgedate MI:LodgementDate Matter lodgement date
m-visaexp MI:VisaExpiryDate Matter visa expiry date
m-decisdue MI:DecisionDueDate Matter decision due date
m-propaddr GetMatterAddress('') Matter property address
m-purchprice MCV:PurchasePrice Matter purchase price
m-deposit MCV:DepositAmount Matter deposit amount
m-bond MCV:DepositBondAmount Matter deposit bond amount
mp-titleref MP:TitleReference Matter title references
m-exch MCV:ExchangeDate Matter exchange date
m-stampduty MCV:StampDutyAmount Matter stamp duty amount
m-stampdutydate MCV:StampDutyDate Matter stamp duty due date
cv-settledate MCV:SettlementDate Matter settlement date
m-datepaid MCV:DatePaid Matter date paid
mp-strataplnum MP:StrataPlanNumber Matter strata plan number
m-expdate Mat:ExpirationDate Matter expiration date
m-lotnumber MS:LotNumber Matter lot number
mp-bylawtype MP:ByLawType Matter by-law type
mp-bylawno MP:ByLawNo Matter By-Law number
mp-specresdate MP:SpecialResolutionDate Matter special resolution date
m-folioid GetMatterFolioId() Matter folio identifier
m-accdate MCP:AccidentDate Matter accident date
m-fieldoflaw Mat:FieldOfLaw Matter field of law
m-industry Mat:Industry The industry of the client
m-investdate MCP:InvestigationDate The date of the investigation for the matter
m-litfunder MCP:LitigationFunder The name of the person funding the litigation
m-transfromsol FormatField(MCP:TransferredFromOtherSolicitor,'YesNo','') Was the matter transferred from another solicitor
m-othsol MCP:OtherSolicitorName The name of the solicitor the matter was transferred from
m-injured GetMatterContactDetail(MAT:MatterGuid,32,?,?) Matter Injured detail m-injured(Position,Field)
m-injuredsol GetMatterContactDetail(MAT:MatterGuid,33,?,?) Deprecated
m-inscomp GetMatterContactDetail(MAT:MatterGuid,34,?,?) Matter Insurance Company detail m-inscomp(Position,Field)
m-doctor GetMatterContactDetail(MAT:MatterGuid,35,?,?) Matter Doctor detail m-doctor(Position,Field)
m-defsol GetMatterContactDetail(MAT:MatterGuid,36,?,?) Deprecated
m-auth GetMatterContactDetail(MAT:MatterGuid,37,?,?) Matter Comp Acq Authority detail m-auth(Position,Field)
m-authsol GetMatterContactDetail(MAT:MatterGuid,38,?,?) Deprecated
m-valuer GetMatterContactDetail(MAT:MatterGuid,39,?,?) Matter Valuer detail m-valuer(Position,Field)
m-archive Mat:ArchiveNo Matter archive number
m-archdate Mat:ArchiveDate Matter archive date
m-initdep MCV:InitialDeposit Matter initial deposit
m-baldep MCV:BalanceDeposit Matter balance deposit
m-baldepdate MCV:BalanceDepositDate Matter balance deposit date
mp-parish MP:Parish Matter parish for the purchase
mp-nature MP:NatureOfBuilding Matter nature of the building being purchased
mp-aggentitle MP:AggregationOfEntitlement The aggregation of the entitlement for the property
m-buldrep FormatField(MCV:BuildingReportCompleted,'YesNo','') Has the building report been completed
m-pestrep FormatField(MCV:PestReportCompleted,'YesNo','') Has the pest report been completed
m-speccond MCV:SpecialConditions Any special conditions for the purchase
m-clientvalue MCP:ClientValuation The clients valuation of the property
m-authvalue MCP:AuthorityValuation The authorities valuation of the property
sc-id SC:SafeCustodyId The safe custody items unique id
sc-doctype SC:DocumentType The document type of the safe custody item
sc-desc SC:SafeCustodyDescription The description of the safe custody item
sc-doc SC:DocumentName The file name of the document
sc-details SC:AdditionalText Additional details about the safe custody item
sc-reviewdate SC:ReminderDate The date the safe custody item should be reviewed
sc-packnum SCP:PacketNumber The packet number of the safe custody item
sc-packdesc SCP:PacketDescription The description of the safe custody packet
sc-location SCP:Location The location of the safe custody packet
ac-id ACT:ActivityId The unique code for the activity
ac-desc ACT:Description The description of the activity
ac-rpu Choose(ACR:ActivityGuid = ACT:ActivityGuid,ACR:RatePerUnit,ACT:RatePerUnit) The rate per unit for the activity
ac-single ACT:UnitDescriptionSingle The unit description for single items
ac-plural ACT:UnitDescriptionPlural The unit description for plural items
m-other GetMatterContactDetail(MAT:MatterGuid,40,?,?) Matter Third Party detail m-other(Pos,Field)
ow-code USR1:UserId Owner Id
ow-email USR1:Email The email address of the matter owner
ow-fax1 USR1:Fax1 The fax 1 of the owner
ow-fax2 USR1:Fax2 The fax 2 of the owner
ow-mob USR1:Mobile The mobile phone of the owner
ow-name USR1:FullName The full name of the owner
ow-ph1 USR1:Phone1 The phone 1 of the owner
ow-ph2 USR1:Phone2 The phone 2 of the owner
ow-user USR1:UserName The username of the owner
ow-rpd USR1:RatePerDay The rate per day of the owner
ow-rph USR1:RatePerHour The rate per hour of the owner
m-trust ME:NameOfTrust The name of the trust for an estate
m-super ME:NameOfSuperannuation The name of the superannuation fund for an estate
m-bankref MCV:BankReference The bank reference for a property matter
m-marrdate MF:MarriageDate The date of the marriage for a matter
m-separdate MF:SeparationDate The date the couple separated for a matter
m-filed MF:DateFiledForDivorce The date the couple filed for divorce in a matter
m-numdep MF:NumDependants The number of dependants of a couple in a matter
m-leaserec ML:LeaseReceived The date the lease was received for a matter
m-executed ML:DateExecuted The date the lease was executed for a matter
m-validuntil ML:ValidUntil The date the lease is valid until
m-optdate ML:OptionDate The option date for a lease in a matter
m-optdesc ML:OptionDescription The description of the option terms for a lease
mc-spouse PER:Spouse The name of the contacts spouse
mc-email2 PER:Email2 The second email of the contact
f-spouse CON:Spouse The spouse of the firm
f-email2 CON:Email2 The second email of the firm
ow-pos USR1:Position The position of the owner
ow-cmnt USR1:Comment The comment about the owner
fe-pos USR:Position The postion of the fee earner
fe-cmnt USR:Comment The comment about the fee earner
fe-rpu Choose(RAT:UserId = USR:UserId,RAT:RatePerHour,USR:RatePerHour)/GetSystemValue('UnitsPerHour') The rate per unit for the fee earner
ow-rpu USR1:RatePerHour/GetSystemValue('UnitsPerHour') The rate per unit for the owner
sa-desc GetAllowanceDesc() The description of the settlement allowance
sa-explanation GetAllowanceExplanation() The explanation of a settlement allowance
sch-payee SCH:Payee The name of the payee for a settlement cheque
sch-amount SCH:Amount The amount of the settlement cheque
sa-pamount SA:PayablebyPurchaser The amount payable by the purchaser for an allowance
sa-vamount SA:PayableByVender The amount payable by the vendor for an allowance
mp-totalunits MP:TotalUnits The total number of units in a strata plan
m-balance MCV:PurchasePrice - MCV:DepositAmount The balance payable net of deposit
sum-sa-vamount Sum:SA:VendAmount The total of vendor payable allowances
sum-sa-pamount Sum:SA:PurchAmount The total of purchaser payable allowances
m-totaldue MCV:TotalDue The amount due net of allowances
sum-sch-amount Sum:Sch:Amount The total of cheques due at settleement
m-adjustdate MCV:AdjustmentDate The adjustment date for the settlement
m-unpaid MCV:UnpaidAmount The total unpaid amount
r-iswriteoff Choose(INC:IncomeClass='Write Off',1,0) Indicates if the receipt is a write off
m-trustbal GetMatterTrustBalance(Mat:MatterGuid,1) The current trust ledger balance for the matter
m-controlbal GetMatterTrustBalance(Mat:MatterGuid,2) The total balance of controlled money ledgers for the matter
m-alltrustbal GetMatterTrustBalance(Mat:MatterGuid,0) The total controlled money and trust ledgers for the matter
i-paylesstrust Choose(INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,1)<0,0,INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,1)) The amount payable less the trust ledger balance
i-paylesscontrol Choose(INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,2)<0,0,INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,2)) The amount payable less the controlled money balance
i-paylessalltrust Choose(INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,0)<0,0,INV:InvoiceTotal+INV:GST - GetMatterTrustBalance(Mat:MatterGuid,0)) The amount payable less the trust & controlled balances
w-qtyu2h FormatQuantity(WKI:ItemType,WKI:Quantity,WKI:QuantityType,WKI:FeeType,'2') Formatted Quantity of WIP/Disbursement conv. units to hours
min-wd-date1 Date(Month(Min:WIPDisb:Date),1,Year(Min:WIPDisb:Date)) First day of month of WIP and Disbusements
max-wd-date30 Date(Month(Max:WIPDisb:Date)+1,1,Year(Max:WIPDisb:Date))-1 Last day of month of WIP and Disbusements
m-othref Mat:OtherReference The other reference for a matter
mp-buildname MP:BuildingName The building name of the property for the matter
mp-lotno MP:Lots The lot number of the property for the matter
mp-unitno MP:UnitNumber The unit number of the property for the matter
mp-strno MP:StreetNumber The street number of the property for the matter
mp-strnoto MP:StreetNumberTo The "To" street number of the property for the matter
mp-strname MP:StreetName The street name of the property for the matter
mp-strtype MP:StreetType The street type of the property for the matter
mp-sub MP:Suburb The suburb of the property for the matter
mp-state MP:State The state of the property for the matter
mp-pc MP:PostCode The postcode of the property for the matter
mp-locality MP:Locality The locality of the property for the matter
mp-council MP:Council The council of the property for the matter
mp-county MP:County The county of the property for the matter
mp-councilpn MP:CouncilPropertyNumber The council property number of the property for the matter
mp-spi MP:SPI The SPI of the property for the matter
mp-lots MP:Lots The lot(s) of the property for the matter
mp-lotplantype MP:PlanType The lot plan type of the property for the matter
mp-lotplanno MP:PlanNumber The lot plan number of the property for the matter
mp-lotsect MP:LotSection The lot section of the property for the matter
mp-lotblock MP:Block The lot block number of the property for the matter
mp-lotstage MP:StageNumber The lot stage number of the property for the matter
mp-lotredevno MP:RedevelopmentNumber The lot redevelopment number of the property for the matter
mp-caallot MP:CrownAllotment The crown allotment of the property for the matter
mp-cablock MP:CrownBlock The crown allotment block of the property for the matter
mp-casection MP:CrownSection The crown allotment section of the property for the matter
mp-caportion MP:CrownPortion The crown allotment portion of the property for the matter
mp-casubdiv MP:CrownSubDivision The crown allot. sub division of the property for the matter
mp-caparish MP:CrownParish The crown allotment parish of the property for the matter
m-vendcount GetMatContactCount(Mat:MatterGuid,16) The total number of vendors for the matter
m-agentcount GetMatContactCount(Mat:MatterGuid,20) The number of agents on the matter
m-appelcount GetMatContactCount(Mat:MatterGuid,9) The number of appelants on the matter
m-appliccount GetMatContactCount(Mat:MatterGuid,5) The number of applicants on a matter
m-authcount GetMatContactCount(Mat:MatterGuid,37) The number of Comp Acq Authorities on a matter
m-authsolcount GetMatContactCount(Mat:MatterGuid,38) Deprecated
m-bankcount GetMatContactCount(Mat:MatterGuid,18) The number of banks on the matter
m-benecount GetMatContactCount(Mat:MatterGuid,12) The number of beneficiaries on a matter
m-brokercount GetMatContactCount(Mat:MatterGuid,19) The number of brokers on a matter
m-childguardcount GetMatContactCount(Mat:MatterGuid,30) The number of Child Guardians on a matter
m-claimcount GetMatContactCount(Mat:MatterGuid,3) The number of claimants on a matter
m-correscount GetMatContactCount(Mat:MatterGuid,0) The number of correspondants on a matter
m-defcount GetMatContactCount(Mat:MatterGuid,2) The number of defendants on a matter
m-defsolcount GetMatContactCount(Mat:MatterGuid,36) Deprecated
m-diaccount GetMatContactCount(Mat:MatterGuid,22) The number of DIAC officers on the matter
m-doctorcount GetMatContactCount(Mat:MatterGuid,35) The number of doctors on the matter
m-employercount GetMatContactCount(Mat:MatterGuid,23) The number of employers on the matter
m-endguardcount GetMatContactCount(Mat:MatterGuid,31) The number of enduring guardians on the matter
m-execcount GetMatContactCount(Mat:MatterGuid,11) The number of executors on the matter
m-injuredcount GetMatContactCount(Mat:MatterGuid,32) The number of injured parties on the matter
m-injuredsolcount GetMatContactCount(Mat:MatterGuid,33) Deprecated
m-inscompcount GetMatContactCount(Mat:MatterGuid,34) The number of insurance companies on the matter
m-othercount GetMatContactCount(Mat:MatterGuid,40) The number of other parties on a matter
m-owncorpsolcount GetMatContactCount(Mat:MatterGuid,26) The number of owners Corp Solicitors on the matter
m-ownercount GetMatContactCount(Mat:MatterGuid,27) The number of property owner's on the matter
m-ownersolcount GetMatContactCount(Mat:MatterGuid,29) Deprecated
m-plaincount GetMatContactCount(Mat:MatterGuid,1) The number of plaintiffs on the matter
m-purchcount GetMatContactCount(Mat:MatterGuid,14) The number of purchasers on a matter
m-purchsolcount GetMatContactCount(Mat:MatterGuid,15) Deprecated
m-relatecount GetMatContactCount(Mat:MatterGuid,13) The number of related persons on the matter
m-respcount GetMatContactCount(Mat:MatterGuid,6) The number of respondents on the matter
m-sponscount GetMatContactCount(Mat:MatterGuid,24) The number of sponsors on the matter
m-stratacount GetMatContactCount(Mat:MatterGuid,21) The number of strata managers on the matter
m-tenantcount GetMatContactCount(Mat:MatterGuid,28) The number of tenants on the matter
m-unicount GetMatContactCount(Mat:MatterGuid,25) The number of universities on the matter
m-valuercount GetMatContactCount(Mat:MatterGuid,39) The number of valuers on the matter
m-vendsolcount GetMatContactCount(Mat:MatterGuid,17) Deprecated
m-xappelcount GetMatContactCount(Mat:MatterGuid,10) The number of cross appelants on the matter
m-xappliccount GetMatContactCount(Mat:MatterGuid,7) The number of cross applicants on a matter
m-xdefcount GetMatContactCount(Mat:MatterGuid,4) The number of cross defendants on the matter
m-xrespcount GetMatContactCount(Mat:MatterGuid,8) The number of cross respondants on the matter
TXT1UCPRRule UCPR Rule Number
TXT2FrmDesc Title of Form Description
TXT3FrmBodyDesc Body of Form Description
TXT4ClaimType Type of Claim
TXT4FilingDet FILING|ISSUING|PREPARATION Filing Issuing or Preparation Details
TXT5FilingDet Filed|Issued|Prepared Filed Issued or Prepared
bs347Cert Yes|No s347 Certification Required
txtOccupierName Occupier Name
txtOccupierLand Land being Occupied
bCosts Yes|No Submission Save as to Costs
txtCrossClaimTitle Cross Claim Title
dOrderDiscovery Date of Order for Discovery
txtNoticeTo Role of Party for Notice
bDefenceFiled Yes|No Defence Filed
bNoticeType FACTS|AUTHENTICITY OF DOCUMENTS|FACTS AND AUTHENTICITY OF DOCUMENTS Notice Type
dNoticeDate Notice Date
txtProdName Name of Party to Produce
txtProdAdd Address of Party to Produce
dProdDate Date for Production
txtPAOrders Name of Person Affected by Orders Sought
txtPARole Role or Capacity of Person Affected by Orders Sought
dOrderDate Order Date
txtOrderParty Role of Party to Answer eg Defendant
dInterrog Date Interrogatories to be Answered
bVerifyAff Yes|No Answer to Interrogatories to be Verified by Affidavit
txtAnsParty Name and Role of Answering Party
txtProdNameRole Name and Role of Party to Produce
bProdCrt court|examiner Production to
txtProdDate Production Date
txtProdTime Production Time
txtProdPlace Production Place
txtProdAddress Production Address for Delivery / Posting
txtWitnesName Subpoena Recipient Name
txtWitnessAdd Subpoena Recipient Address
dLDServ Last Day for Service of Subpoena
dAttendEvid Date for Attendance to Give Evidence
txtAttendEvidTime Time for Attendance to Give Evidence
txtAttendEvidPlace Place for Attendance to Give Evidence
dOrderProd Last Date for Service of Order for Production
txtPPName Name of Producing Party
txtPPAdd Address of Producing Party
txtTutorForName Name of Party to have Tutor
txtTutorForRole Role of Party to have Tutor
dPayDate Date of Payment
nPayAmt Payment Amount
txtLandTF Land Title and Folio Numbers
txtLandAdd Land Address
txtPartyCosts Role of Party to Pay Plaintiff's Costs
nJudgAmt Judgment Amount
txtAffDepName Deponent Name
txtAffDepAdd Deponent Address
txtAffDepOcc Deponent Occupation
txtAffDepRole Deponent Role
dAffServ Date of Service
txtAffServPlace Place of Service
txtAffServPartySrvd Name of Party Served
txtAffServMethodSrv Method of Service
txtAffServDocuments Description of Documents Served
txtExhibitMark Exhbit Identifying Mark
txtAffDate Date of Affidavit
txtAffSwearType sworn|affirmed Affidavit Sworn or Affirmed
txtDocType Judgment|Order Judgment or Order
dOrderEntered Date Order Entered
txtDocStatus Registration|Filing Document for Registration or Filing
txtFrmType CERTIFICATE OF JUDGMENT|ORDER Certificate of Judgment or Order
nPaymentsCredits Payments made or Credits accrued
nInterest Interest Amount
nRegoFilingFee Registration or Filing Fee
nInterestRate Interest Rate
nTotalAmt Total Amount Due
nInstalAmt Instalment Amount
txtInstalFreq Weekly|Fortnightly|Monthly Instalment Frequency
dInstalDate First Instalment Date
txtPAJudgRole Role in Judgment eg Creditor or Debtor
txtMotType OBJECTION TO INSTALMENT ORDER|OBJECTION TO ORDER REFUSING INSTALMENT APPLICAITON Motion Type
txtProc stayed|not stayed Proceedings Status
dJudg Date of Judgment
dExamDue Due Date for Examination Notice
txtExamName Name of Party to be Examined
txtExamAdd Address of Party to be Examined
txtArrestName Name of Party for Arrest Warrant
txtArrestAdd Address of Party to be Arrested
bLeaveWrit Yes|No Is Leave to Issue a Writ of Possession Sought
txtPartyExecName Person Entitled to Execution of Judgment
txtPartyExecRole Role of Person Entitled to Execution of Judgment
txtPartyLiaName Name of Person Liable for Execution of Judgment
txtPartyLiaRole Role of Person Liable for Execution of Judgment
nAmtLevyCosts Total Amount Levied for Costs as at Date of Writ
dWritPoss Date Writ of Possession Issued
txtGoodsDeliv Description of Goods to be Delivered
txtGoodsLocat Description of Location/s of Goods for Delivery
txtGoodsPersonLiab Location of Person Liable to Execution of Judgment's Goods
nWritCosts Costs of Writ
nTotalLevied Total Amount to be Levied
nWritEnforceCosts Total Amount to be Enforced for Costs
txtPropLocation Location of Property
nAmtUnpaidJudgDebt Amount of Unpaid Judgment Debt
nEnforcementCosts Enforcement Costs
dAuctionDate Auction Date
dWritLevyProp Date of Writ for Levy of Property
txtAuctionTime Time of Auction
txtAuctionPlace Auction Place
txtGarnisheeOf wages|salary|debt Garnishee Of
nGarnisheeAmt Garnishee Amount
txtGarnisheeStateStat NOT DEBT DUE OR ACCRUING|NO WAGE OR SALARY PAYABLE Garnishee Statement Status
txtChargeeName Name of Chargee
txtInterestsList List Interests in Specific Terms
txtDispPropClaim the property|the proceeds of sale|the value of the property Disputed Property Claim in Respect Of
txtDispProperty Property Details
txtDispPropClDet Details of Claim
txtNoticeType CHANGE OF SOLICITOR|APPOINTMENT OF SOLICITOR Notice Of
txtPrevSolName Previous Solicitor Name and Firm
txtNoticeName Name of Party being Notified
txtNoticePeriod Number of Days
txtNoticeParties Names of Other Parties to be Served
txtNoticeAddress Last known Residential or Business Address of Parties
txtCBParty associate|judge|court below Who made the Decision
txtSummonsType SUMMONS COMMENCING AN APPEAL (PART 50)|SUMMONS SEEKING LEAVE TO APPEAL (PART 50) Summons Type
txtAppDate Date Appeal to be Commenced Before
txtAppealType Appeal Type
txtProbateSummType PROBATE|ADMINISTRATION|ADMINISTRATION WITH THE WILL ANNEXED|RESEAL Summons Type
txtGrantType PROBATE|LETTERS OF ADMINISTRATION|LETTERS OF ADMINISTRATION WITH WILL ANNEXED Grant Type
txtGrantParty Name and Address of Party to whom Grant is Made
txtGrantBasis Grant Basis
txtResealJuris Jurisdiction of Original Grant
dResealOrigGrant Date of Original Grant
m-xclaim GetMatterContactDetail(MAT:MatterGuid,45,?,?) Matter Cross Claimant detail m-xclaim(Position,Field)
m-xclaimcount GetMatContactCount(Mat:MatterGuid,45) The number of cross claimants on the matter
m-mortgagee GetMatterContactDetail(MAT:MatterGuid,42,?,?) Matter mortgagee detail m-mortgagee(Position,Field)
m-mortgagor GetMatterContactDetail(MAT:MatterGuid,43,?,?) Matter mortgagor detail m-mortgagor(Position,Field)
m-mccourt GetMatterContactDetail(MAT:MatterGuid,44,?,?) Matter court detail m-mccourt(Position,Field)
m-mortgageecount GetMatContactCount(Mat:MatterGuid,42) The number of mortgagees on the matter
m-mortgagorcount GetMatContactCount(Mat:MatterGuid,43) The number of mortgagors on the matter
m-mccourtcount GetMatContactCount(Mat:MatterGuid,44) The number of courts on the matter
m-clienttype MCV:ClientStatus The client type description for the matter
m-garnishee GetMatterContactDetail(MAT:MatterGuid,46,?,?) Matter garnishee detail m-garnishee(Position,Field)
m-tutor GetMatterContactDetail(MAT:MatterGuid,47,?,?) Matter tutor detail m-tutor(Position,Field)
m-garnisheecount GetMatContactCount(Mat:MatterGuid,46) The number of garnishees on the matter
m-tutorcount GetMatContactCount(Mat:MatterGuid,47) The number of tutors on the matter
cu-id GetCurrentUserInfo('UserId') The User Id of the currently logged on user
cu-username GetCurrentUserInfo('UserName') The User Name of the currently logged on user
cu-code GetCurrentUserInfo('UserGuid') The User Code of the currently logged on user
m-matbelow Mat:MatterTitleBelow The title of the matter below this one
m-courtbelow Mat:CourtBelow The court the below matter was in
m-matnobelow Mat:CaseNumberBelow The matter number of the case below this one
m-hearingdates Mat:DateOfHearings The dates of the previous hearings for this matter
m-matdate Mat:MaterialDate The material date of the matter
m-decis Mat:Decision The decison of the previous hearings
f-emailserv CON:ElectronicServiceEmail The email address that court notifications should be sent to
ow-praccert USR1:PracticingCertificateNo The practicing cert. number of the fee earner of the matte
fe-praccert USR:PracticingCertificateNo The practicing certificate number of the owner of the matte
m-deceased GetMatterContactDetail(MAT:MatterGuid,48,?,?) Matter deceased detail m-deceased(Position,Field)
m-deceasedcount GetMatContactCount(Mat:MatterGuid,48) The number of deceased on the matter
m-dateofwill ME:DateOfWill The date the will for the matter
m-dateofcod ME:DateOfCodicils The dates of the codicils for the matter
m-codcount ME:NumberOfCodicils The number of codicils for the will for the matter
m-multicod Choose(ME:NumberOfCodicils>1,'Yes','No') Are there multiple codicils for the will of the matter
m-grantrep ME:DateOfGrantOfRep The date of grant of probate/admin for the matter
m-discdate ML:DisclosureDate The leasing disclosure date for a matter
m-estaward MCP:EstimatedAward The estimated award for a litigation matter
s-serviceemail GetSystemValue('ElectronicServiceEmail') The firms electronic service email address
m-winestex Mat:CostEstimateIfWinExGST The Ex-GST estimate of costs if successful for the matter
m-winestinc Mat:CostEstimateIfWinIncGST The Inc-GST estimate of costs if successful for the matter
m-failestex Mat:CostEstimateIfFailExGST The Ex-GST estimate of costs if unsuccessful for the matter
m-failestinc Mat:CostEstimateIfFailIncGST The Inc-GST estimate of costs if unsuccessful for the matter
m-witness GetMatterContactDetail(MAT:MatterGuid,49,?,?) Matter witness detail m-witness(Position,Field)
m-witnesscount GetMatContactCount(Mat:MatterGuid,49) The number of witnesses on the matter
txtListDetails Next Appropriate Listing Date Next Appropriate Listing Date
nOriginalAmtJO Original Amount of Judgment / Order
txtOptOutParty Name of Person Opting out of Proceedings
txtOptOutPartyAdd Address of Person Opting out of Proceedings
txtApplicantName Applicant Name
txtAnnexMark Annexure Mark eg A
txtAppDeFacDP de facto spouse|domestic partner Application Type: De Facto Spouse or Domestic Partner
txtAppDeFacDP2 de facto relationship|domestic partnership Application Type: De facto relationship/Domestic partnership
txtAppName Applicant Name
txtSpouseName Spouse Name
nBondAmt Bond Amount
txtAdminName Administrator Name
nPropValue Property Value
txtConsentingParty Name of Consenting Party
txtConsentingPartyAdd Address of Consenting Party
txtConsentingPartyOcc Occupation of Consenting Party
txtInterestedWitness Name of Interested Witness
txtBenefitDetails Details of Benefit to Consenting Party
txtAffServPartySrvdAdd Address of Party Served
txtDeceasedPlaceDeath Deceased Place of Death
txtServicePlace Place of Service
txtReqPartyName Requesting Party Name
dReqDate Request Date
txtCaveatorInterest Caveator's Interest Details
txtCaveatorName Name of Person Withdrawing Caveat
dCaveat Date of Caveat
txtNoticeType2 ACCOUNTS|COMMISSION|ACCOUNTS AND COMMISSION Notice of Intended Objection To
txtNoticeType2b passing of accounts|allowance of commission|passing of accounts| and allowance of commission Notice of Intended Objection To
txtNoticeStatus executor|administrator Notice of Objection to Appointment of:
txtProposingParty Proposing Party Name
txtAppointeeName Party Proposed to be Appointed
txtProposedAppointment txtProposedAppointment
txtObjectingPartyInt Details of Objecting Party's Interest
txtAffidavitType ASSETS|LIABILITIES|ASSETS AND LIABILITIES Affidavit of Additional:
m-injurydate Mat:DateOfInjury The date the injury occured in the compensation matter
m-injurynotice MCP:DateOfNoticeOfInjury The date the notice of injury in the compensation matter
m-injuryplace MCP:PlaceOfInjury The place the injury occured in the compensation matter
m-injurydesc MCP:InjuryDescription The description of the injury in the compensation matter
m-injuryreason MCP:HowDidInjuryOccur How the injury occured in the compensation matter
m-claimno MCP:ClaimNumber The claim number in the compensation matter
fn-user FIL:Username The username of the person who entered the file note
fn-date FIL:Date The date of the file note
fn-time FIL:Time The time of the file note
m-dependant GetMatterContactDetail(MAT:MatterGuid,50,?,?) Matter dependant detail m-dependant(Position,Field)
m-dependantcount GetMatContactCount(Mat:MatterGuid,50) The number of dependants on the matter
m-filing GetMatterContactDetail(MAT:MatterGuid,51,?,?) Matter filing party detail m-filing(Position,Field)
m-filingcount GetMatContactCount(Mat:MatterGuid,51) The number of filing parties on the matter
txtHearingLocation Preferred Location for Hearing
txtAccessDays Number of Days for First Access to Documents
txtAccessDetails Details of First Access To
m-senttoins MCP:DateSentToInsurer Date the matter was sent to the insurer
m-recbyins MCP:DateReceivedByInsurer Date the matter was received from the insurer
m-acclocat Mat:PlaceOfInjury The place the accident took place for the matter
m-vehicleowner GetMatterContactDetail(MAT:MatterGuid,52,?,?) The name of the owner of the vehicle in the accident
m-vehicleownercount GetMatContactCount(Mat:MatterGuid,52) The number of vehicle owners on the matter
m-driver GetMatterContactDetail(MAT:MatterGuid,53,?,?) The driver of the vehicle in the accident
m-drivercount GetMatContactCount(Mat:MatterGuid,53) The number of drivers on the matter
m-interpreter GetMatterContactDetail(MAT:MatterGuid,54,?,?) The interpreter for the matter
m-interpretercount GetMatContactCount(Mat:MatterGuid,54) The number of interpreters on the matter
txtLECRuleNo LEC Rule No (if applicable)
txtLECClassDesc LEC Class Description
txtLECClassSelect 1|2|3 Application Class
m-divrcplace MF:DivorcePlace The place of the divorce for the matter
m-cohabdate MF:CohabitationDate The date of cohabitation for the matter
m-marrplace MF:MarriagePlace The place of the marriage for the matter
m-marrctry MF:MarriageCountry The country of the marriage for the matter
m-divrcctry MF:DivorceCountry The country of the divorce for the matter
m-divrcdate MF:DivorceDate The date of the divorce for the matter
m-child GetMatterContactDetail(MAT:MatterGuid,55,?,?) Matter child detail m-garnishee(Position,Field)
m-husband GetMatterContactDetail(MAT:MatterGuid,56,?,?) Matter husband detail m-husband(Position,Field)
m-wife GetMatterContactDetail(MAT:MatterGuid,57,?,?) Matter wife detail m-garnishee(Position,Field)
m-childcount GetMatContactCount(Mat:MatterGuid,55) The number of children on the matter
m-husbandcount GetMatContactCount(Mat:MatterGuid,56) The number of husbands on the matter
m-wifecount GetMatContactCount(Mat:MatterGuid,57) The number of wifes on the matter
m-titleref MP:TitleReference Deprecated
s-db GetDB() The name of the current database
txtPartyServedFName Family Name of Person being Served
txtPartyServedGName Given Names of Person being Served
txtAffDepGName Given Names of Deponenteing Served
txtAffDepFName Family Name of Deponent
txtAffServPartySrvdGName Given Names of Party Served
txtAffServPartySrvdFName Family Name of Party Served
txtOrderJudg Name of Judge who made Order
txtOrderCodePro State the Name of the Code or Protocol
mc-famlawyerno PER:FamilyCourtLawyerNo The family court lawyer number of the solicitor
s-servicefax GetSystemValue('ElectronicServiceFax') The firms electronic service fax number
txtCostsPartyGName Given Names of Person from Whom Costs are Claimed
txtCostsPartyFName Family Name of Person from Whom Costs are Claimed
dServDateICA Date the Itemised Costs Account served on you
dNotDateICA Date this Notice served on you or by you
txtFamNamePrevUsed Family Name Previously Used
txtGivNamePrevUsed Given Names Previously Used
txtNewFamilyName Family Name to be Used Now
txtNewGivenName Given Names to be Used Now
dBoundUnder Date Bound by Undertaking Until
txtPostDate Date of Posting
m-clientdetail GetMatterContactDetail(MAT:MatterGuid,41,?,?) The client details for the matter
m-famclientid MF:FamilyCourtClientId The family court client id for the matter
mp-lotno2 MP:Lot2 The second lot number of the property for the matter
mp-lotno3 MP:Lot3 The third lot number of the property for the matter
mp-lotno4 MP:Lot4 The fourth lot number of the property for the matter
mp-lotno5 MP:Lot5 The fifth lot number of the property for the matter
mp-lotplanno2 MP:PlanNumber2 The second lot plan number of the property for the matter
mp-lotplanno3 MP:PlanNumber3 The third lot plan number of the property for the matter
mp-lotplanno4 MP:PlanNumber4 The fourth lot plan number of the property for the matter
mp-lotplanno5 MP:PlanNumber5 The fifth lot plan number of the property for the matter
mp-lotplantype2 MP:PlanType2 The second lot plan type of the property for the matter
mp-lotplantype3 MP:PlanType3 The third lot plan type of the property for the matter
mp-lotplantype4 MP:PlanType4 The fourth lot plan type of the property for the matter
mp-lotplantype5 MP:PlanType5 The fifth lot plan type of the property for the matter
mp-titleref1 GetTitleRef(MP:TitleReference,1) The first title reference for the matter
mp-titleref2 GetTitleRef(MP:TitleReference,2) The second title reference for the matter
mp-titleref3 GetTitleRef(MP:TitleReference,3) The third title reference for the matter
mp-titleref4 GetTitleRef(MP:TitleReference,4) The fourth title reference for the matter
mp-titleref5 GetTitleRef(MP:TitleReference,5) The fifth title reference for the matter
m-owfesame Choose(Mat:PrimaryFeeEarnerGuid=Mat:OwnerGuid,1,0) Are the matter Primary Fee Earner and Owner the same
cu-fullname GetCurrentUserInfo('FullName') The full name of the currently logged on user
cu-rph GetCurrentUserInfo('rph') The rate per hour of the currently logged on user
cu-rpd GetCurrentUserInfo('rpd') The rate per day of the currently logged on user
cu-pos GetCurrentUserInfo('Position') The position of the currently logged on user
cu-phone GetCurrentUserInfo('Phone') The phone of the currently logged on user
cu-fax GetCurrentUserInfo('Fax') The fax of the currently logged on user
cu-mobile GetCurrentUserInfo('Mobile') The mobile of the currently logged on user
cu-email GetCurrentUserInfo('Email') The email of the currently logged on user
ir-current GetCurrentInterestRate() The current interest rate
txtOrderCourtJudg Order Made By
txtBankruptEstName Full Name of Bankrupt Estate
txtNoticeAdd Address of Party
txtCapacityofParty Capacity of Party issuing Document (eg Creditor)
dNextCourtDate Date of Next Court Date
txtNextCourtTime Time of Next Court Date (eg 10:00am)
txtCourtListingFor Listed For
txtPartyServedPos Description of Office or Position
txtDefDetails Why is the deferral required and when can the fees be paid
bEmail Yes|No Send letter via email
bSendViaEmail Yes|No Send letter via email
txtWorkDetails Provide a brief description of the work we will do
bExcludeWork Yes|No Is there specific work not covered by the Costs Agreement
txtExcludeDetails If Yes to previous question provide details
nFeesExGSTDisb Fees excluding GST and Disbursements
nEstDisbExp Estimated disbursements and expenses
txtEvent Work up to event eg filing of your defence
bExpertMat Yes|No Is expert evidence required
txtExpertDetail If Yes to previous question type of expert material
bPlainApp Yes|No Do we act for the plaintiff or applicant
bLitMatter Yes|No Is this is a litigous matter
bInsolvencyRates Yes|No Is the client being charged at our insolvency rates
txtClaimInRespectOf Claim in Respect of which Property?
txtBasisClaim Basis of the Claim (eg you purchased prop, gift)
txtPossession Why is property in possession of Judgement Debtor
mc-fulladdr GetContactStreetAddress('') The full street address of the matter contact
mc-fulladdrnl GetContactStreetAddress('1') The full street address of the matter contact with newlines
mc-fullpostal GetContactPostalAddress('') The full postal address of the matter contact
mc-fullpostalnl GetContactPostalAddress('1') The full postal address of the matter contact with new lines
mc-fulldx GetContactDXAddress() The full DX address of the matter contact
m-ldcouns GetMatterContactDetail(MAT:MatterGuid,58,?,?) The lead counsel on the matter
m-jnrcouns GetMatterContactDetail(MAT:MatterGuid,59,?,?) The junior counsel on the matter
i-fcgst INV:ForeignCurrencyGST The GST on the matter in the foreign currency
i-fcpay INV:ForeignCurrencyAmount+INV:ForeignCurrencyGST The amount payable in the foreign currency
i-fcpayint (INV:InvoiceTotal+INV:GST+INV:Interest)*INV:ForeignCurrencyRate Amount Payable including Interest in the foreign currency
i-fcout INV:AmountOutstandingIncGST*INV:ForeignCurrencyRate The amount outstanding in the foreign currency
i-fcoutint (INV:AmountOutstandingIncGST + INV:Interest - INV:InterestPaid)*INV:ForeignCurrencyRate The amount outstanding inc interest in the foreign currency
i-fcpaynd (INV:InvoiceTotal+INV:GST+INV:Interest+Sum:WIP:DiscountsInc)*INV:ForeignCurrencyRate Undiscounted amount for an invoice in the foreign currency
i-fcrec INV:AmountPaidIncGST*INV:ForeignCurrencyRate Total amount received for this invoice in foreign currency
i-fcrecint (INV:AmountPaidIncGST+INV:InterestPaid)*INV:ForeignCurrencyRate Amount Received including Interest in foreign currency
i-fctotal INV:ForeignCurrencyAmount+INV:ForeignCurrencyGST Total of invoice in foreign currency
i-fctotalex INV:ForeignCurrencyAmount Ex-GST total of invoice in foreign currency
w-fcgst WKI:GSTCharged*INV:ForeignCurrencyRate GST of WIP/Disbursement Item in foreign currency
w-fcprice Choose(WKI:InvoiceGuid~='',CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGSTCharged,WKI:PriceCharged),CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGST,WKI:Price))*INV:ForeignCurrencyRate Price of WIP/Disbursement Item in foreign currency
w-fcpriceex Choose(WKI:InvoiceGuid~='',WKI:PriceCharged,WKI:Price)*INV:ForeignCurrencyRate Ex GST Price of WIP/Disbursement Item in foreign currency
w-fcpriceinc Choose(WKI:InvoiceGuid~='',WKI:PriceIncGSTCharged,WKI:PriceIncGST)*INV:ForeignCurrencyRate Inc GST Price of WIP/Disbursement Item in foreign currency
sum-d-fcgst Sum:Disb:GST*INV:ForeignCurrencyRate The total of the gst for disbursements in the doc in foreign
sum-d-fcprice CHOOSE(Mat:GSTType=GST:Inclusive,Sum:Disb:PriceIncGST,Sum:Disb:Price)*INV:ForeignCurrencyRate The total of the price for disbs. in the doc in foreign
sum-d-fcpriceinc Sum:Disb:PriceIncGST*INV:ForeignCurrencyRate Total of the Inc GST Price for disbs. in the doc in foreign
sum-d-fcpriceex Sum:Disb:Price*INV:ForeignCurrencyRate Total of the Ex GST Price for disbs in the doc in foreign
sum-w-fcdisc Sum:WIP:Discounts*INV:ForeignCurrencyRate Total amount discounted on Time Entries in foreign currency
sum-w-fcdiscex Sum:WIP:DiscountsEx*INV:ForeignCurrencyRate Ex-GST total amount discounted on Time Entries in foreign
sum-w-fcdiscinc Sum:WIP:DiscountsInc*INV:ForeignCurrencyRate Inc GST total amount discounted on Time Entries in foreign
sum-w-fcfxd Sum:WIP:Fixed*INV:ForeignCurrencyRate Total amount of fixed amount Time Entries in foreign
sum-w-fcgst Sum:WIP:GST*INV:ForeignCurrencyRate The total of the gst for fees printed in the doc in foreign
sum-w-fcgstd Sum:WIP:GSTDisc*INV:ForeignCurrencyRate The total of the gst for discounts in foreign
sum-w-fcgstnd Sum:WIP:GSTNoDisc*INV:ForeignCurrencyRate The total of the gst for undiscounted fees in foreign
sum-w-fcprice CHOOSE(Mat:GSTType=GST:Inclusive,Sum:WIP:PriceIncGST,Sum:WIP:Price)*INV:ForeignCurrencyRate Total of the price for fees printed in the doc in foreign
sum-w-fcpriceex Sum:WIP:Price*INV:ForeignCurrencyRate Total of the Ex GST Price for fees in the doc in foreign
sum-w-fcpriceinc Sum:WIP:PriceIncGST*INV:ForeignCurrencyRate Inc-GST total of Fees excluding any discounts in foreign
i-fcrate INV:ForeignCurrencyRate The exchange rate used for this invoice
mc-ref MTC:Reference The reference for the matter contact
w-qtyh2u FormatQuantity(WKI:ItemType,WKI:Quantity,WKI:QuantityType,WKI:FeeType,'3') Formatted Quantity of WIP/Disbursement conv. hours to units
sum-dng-price Sum:DisbNoGST:Price The total of the disbursements that do not have GST
sum-dhg-gst Sum:DisbHasGST:GST The total of the gst for disbursements that have GST
sum-dhg-price CHOOSE(Mat:GSTType=GST:Inclusive,Sum:DisbHasGST:PriceIncGST,Sum:DisbHasGST:Price) The total of the price for disbursements that have GST
sum-dhg-priceex Sum:DisbHasGST:Price Total of the Ex GST Price for disbusements that have GST
count-disbng Count:NoGST:Disb Count of the number of items in a Multi:DisbNoGST
count-disbhg Count:HasGST:Disb Count of the number of items in a Multi:DisbHasGST
sum-dhg-fcgst Sum:DisbHasGST:GST*INV:ForeignCurrencyRate The total of the gst for disbs that have GST in foreign curr
sum-dhg-fcprice CHOOSE(Mat:GSTType=GST:Inclusive,Sum:DisbHasGST:PriceIncGST,Sum:DisbHasGST:Price)*INV:ForeignCurrencyRate The total of the price for disbs that have GST in foreign
sum-dhg-fcpriceex Sum:DisbHasGST:Price*INV:ForeignCurrencyRate Total of the Ex GST Price for disbs that have GST in foreign
sum-dhg-priceinc Sum:DisbHasGST:PriceIncGST Total of the Inc GST Price for disbusements that have GST
sum-dhg-fcpriceinc Sum:DisbHasGST:PriceIncGST*INV:ForeignCurrencyRate Total of the Inc GST Price for disbs with GST in foreign cur
sum-dng-fcprice Sum:DisbNoGST:Price*INV:ForeignCurrencyRate The total of the disbs that do not have GST in foreign curr
ss-rph WKI:Quantity The rate per hour used for the fee earner on the invoice
ss-rpd USR:RatePerDay The rate per day used for the fee earner on the invoice
ss-rpu USR:RatePerHour/GetSystemValue('UnitsPerHour') The rate per unit used for the fee earner on the invoice
i-ispart Choose(BillingPercent=1,0,1) Has a partial billing contact been selected
i-parttotal CHOOSE(Mat:GSTType=GST:Inclusive,INV:InvoiceTotal+INV:GST,INV:InvoiceTotal)*BillingPercent The partial billing total of the invoice
i-parttotalex INV:InvoiceTotal*BillingPercent The partial billing ex-GST total of the invoice
i-partpay (INV:InvoiceTotal+INV:GST)*BillingPercent The partial billing total payable amount of the invoice
i-partgst INV:GST*BillingPercent The partial billing GST of the invoice
i-billpc BillingPercent*100 The partial billing percentage being used for the invoice
i-isdisc Choose(Sum:WIP:Discounts=0,0,1) Is this invoice discounted
i-totalexnd Sum:WIP:Price+Sum:Disb:Price+SELF.Sum:WIP:Discounts The undiscounted ex-GST total of the invoice
i-totalnd CHOOSE(Mat:GSTType=GST:Inclusive,Sum:WIP:PriceIncGST+Sum:Disb:PriceIncGST,Sum:WIP:Price+Sum:Disb:Price) The undiscounted total of the invoice
sum-w-pricedisc CHOOSE(Mat:GSTType=GST:Inclusive,INV:InvoiceTotal+INV:GST-Sum:Disb:PriceIncGST,INV:InvoiceTotal-Sum:Disb:Price) The discounted fees in the invoices
sum-w-gstdisc INV:GST-Sum:Disb:GST The discounted GST on the fees in the invoice
sum-w-priceexdisc INV:InvoiceTotal-Sum:Disb:Price The ex-GST discounted fees in the invoices
sum-w-priceincdisc INV:InvoiceTotal+INV:GST-Sum:Disb:PriceIncGST The inc-GST discounted fees in the invoice
m-conveyancer GetMatterContactDetail(MAT:MatterGuid,61,?,?) Matter Conveyancer detail m-conveyancer(Position,Field)
m-conveyancercount GetMatContactCount(Mat:MatterGuid,61) The number of conveyancers on a matter
m-sublessee GetMatterContactDetail(MAT:MatterGuid,63,?,?) The sub lessee on the matter
m-sublessor GetMatterContactDetail(MAT:MatterGuid,62,?,?) The sub lessor on the matter
m-sublesseecount GetMatContactCount(Mat:MatterGuid,63) The number of sub lessees on the matter
m-sublessorcount GetMatContactCount(Mat:MatterGuid,62) The number of sub lessors on the matter
m-accused GetMatterContactDetail(MAT:MatterGuid,64,?,?) The accused person on the matter
m-accusedcount GetMatContactCount(Mat:MatterGuid,64) The number of accused people on the matter
fn-note FIL:Note The details of the file note
txtRegDealNo Registered Dealing No
txtRDTorrensTitle Registered Dealing Torrens Title
txtRegPropName Registered Proprietor Name(s) and addresses
txtLandRD Land Registered Dealing Wording
txtDCB Document Collection Box (if applicable)
txtBankOf Applicant is Bankrupt or Enter Bankrupts Name
txtTenancy Tenancy Wording
txtEncumbrances Encumbrances (if applicable)
txtStatDecs Statutory Declarations By
txtCaveatNo Caveat Number
bLandYN Yes|No Does application relate to Land?
txtCaveatorName2 Caveator Name
txtDealNoCancel Dealing No of Cancelled Dealing
txtRegPropName2 Registered Proprietor Name
txtNewRegPropName New Registered Proprietor Name
txtJudgCred Judgment Creditor Name
txtWritNo Writ Number
txtIssuingCrt Issuing Court
txtRPNewName Registered Proprietor New Name
txtBankruptDebtor Bankrupt / Debtor Name
txtBankDebtWord Application against party - wording to be used
txtSection Section Relied Upon
txtCautionNo Caution No
txtServTenement Servient Tenement Title
txtDomTenement Dominant Tenement Title
txtEasementNature Nature of Easement
txtEasementNo Number of Easement
txtCaveatPAction Action to be Prohibited
txtInstrumentWording Instrument / Facts Wording
txtApplicationNo Application Number
txtNewAdd New Address for Service of Notice
txtChargerName Charger Name
txtRPOf Registered Proprietor Of
txtProvisionsWord Provisions set out in
txtPaymentOfThe Payment of the
txtPayProvisions Payment provisions set out in the
txtChargeDisc Charge Discharged
txtMemorandumNo Memorandum No
txtMortgageeDischarged Mortgagee Discharged
txtMortgageNo Mortgage No.
txtEstateWording Estate Wording
txtShareTransferred Share Transferred
txtNoPages No of Pages
txtOptRenew Option to Renew Clause
txtOptPur Option to Purchase Clause
txtTransferor Transferor Name
txtConsideration Consideration
txtTransferee Transferee Name
txtCouncilName Council Name
txtChargeNo Charge No
txtChargeDate Charge Date
txtMortgageDate Mortgage Date
txtTerm Term
txtCommDate Commencement Date
txtTerminationDate Termination Date
txtPPAnnexMark Profit ࠰rendre Annexure Mark
txtPPAnnPages Profit ࠰rendre Annexure Pages
txtCovAnnexMark Covenants Annexure Mark
txtCovAnnexPages Covenant Annexure Pages
txtEasementDesc Description of Easement
txtTransferNo Transfer No
txtMinCoals What is transferred (delete as appropriate)
txtConsidWord Consideration wording delete as applicable
txtWillEntitle Entitlement under the Will (delete as appropriate)
txtGrantProbate Grant Type
txtGrantee Name of Party Probate / Admin Granted to
txtGrantAttached Probate / Admin Grant attached as
txtConsentWording Consent Wording for Admin / Executor / Trustee
txtSignWord Signed by
txtGrantNo Grant Number
txtTorrensTitle Torrens Title
txtEntitlementAE Entitlement of Applicant
txtAppST Applicant Name Servient Tenement
txtAppDT Applicant Name Dominant Tenement
txtEasementSetOut Easement Set Out in and No (if applicable)
txtConsentAnnex Annexure Mark for Consent
txtCovenantNo Positive Covenant No
txtRestriction Restriction
txtCaveatWithdrawn Caveat Withdrawn
txtLessor Lessor Name and Address
txtLessee Lessee Name and Address
dCommencementDate Commencement Date
dTerminatingDate Terminating Date
txtPropDesc Property Leased Description
txtLeaseProv Provisions set out in (select wording)
txtLMCNo Lease / Mortgage or Charge Number
txtDeathCert Death Certificate Type
txtDeathCertNo Death Certificate Number
txtTypeOfDoc Lease / Mortgage / Charge
txtPostiveCNo Positive Covenant Number
txtRegoNo Registration Number
txtNatureOfRequest Nature of Request
txtTextRequest Text of Request
txtHeadLeaseNo Lease Number
txtOptionPeriod Option Period (if applicable)
txtOptionSetOutIn Option Clause set out in (if applicable)
txtReservedRights Reserving rights set out in
txtRentSetOut Rent set out in
txtRentSetOutDoc Rent set out in document
txtOptionPurch Option to purchase set out in
txtHLTorrensTitle Head Lease Torrens Title
txtLeaseSurrendered Lease Surrendered
txtDocAffected Lease surender affects
txtPrescribedAuthority Prescribed Authority
txtRentIncRed Rent increased / reduced
txtTermIncRed Term increased / reduced to
txtLeaseVaried Lease Varied
mc-middlenames PER:MiddleNames The contacts middle names
sum-i-fcgst Sum:Inv:FCGST The total of the FC gst for invoices printed in the document
sum-i-fcout Sum:Inv:FCGST + Sum:Inv:FCTotal - Sum:Inv:FCPaid - Sum:Inv:FCWriteOffInc The total of the FC outstanding amount for invoices printed
sum-i-fcpaid Sum:Inv:FCPaid The total FC paid on the invoices printed in the document
sum-i-fcpay Sum:Inv:FCGST + Sum:Inv:FCTotal The total of the FC payable amounts printed in the document
sum-i-fctotal Sum:Inv:FCTotal The FC total of the invoices(ex-gst) printed in the document
sum-i-fcwriteoffinc Sum:Inv:FCWriteOffInc The FC total written off amount (inc-gst) in the document
sum-i-fcint Sum:Inv:FCInterest The total of all the FC interest included in the invoices
sum-i-fcintout Sum:Inv:FCInterest - Sum:Inv:FCInterestPaid The total amount of FC interest unpaid for all the invoices
sum-i-fcoutint Sum:Inv:FCGST + Sum:Inv:FCTotal - Sum:Inv:FCPaid + Sum:Inv:FCInterest - Sum:Inv:FCInterestPaid - Sum:Inv:FCWriteOffInc The sum of the FC amount outstanding including interest
sum-i-fcpaidint Sum:Inv:FCPaid + Sum:Int:FCInterestPaid The total FC paid on invoice printed including interest
i-fcint INV:Interest*INV:ForeignCurrencyRate The amount of FC interest added to this invoice
i-fcintout (INV:Interest - INV:InterestPaid)*INV:ForeignCurrencyRate The amount of FC interest on the invoice not yet paid
i-fcintrec INV:InterestPaid*INV:ForeignCurrencyRate The amount of FC interest that has been paid on the invoice
m-cli GetMatterContactDetail(MAT:MatterGuid,41,?,?) The client details for the matter
i-gstnd Sum:WIP:GSTNoDisc+Sum:Disb:GST The undiscounted GST total of the invoice
m-informant GetMatterContactDetail(MAT:MatterGuid,65,?,?) Matter informant detail m-informant(Position,Field)
m-informantcount GetMatContactCount(Mat:MatterGuid,65) The number of on the matter
m-prosecutor GetMatterContactDetail(MAT:MatterGuid,66,?,?) Matter prosecutor detail m-prosecutor(Position,Field)
m-prosecutorcount GetMatContactCount(Mat:MatterGuid,66) The number of prosecutor on the matter
m-judgeassoc GetMatterContactDetail(MAT:MatterGuid,67,?,?) Matter Judge Associate detail m-judgeassoc(Position,Field)
m-judgeassoccount GetMatContactCount(Mat:MatterGuid,67) The number of Judge's Assoicates on the matter
m-expert GetMatterContactDetail(MAT:MatterGuid,68,?,?) Matter Expert detail m-expert(Position,Field)
m-expertcount GetMatContactCount(Mat:MatterGuid,68) The number of experts on the matter
m-investigator GetMatterContactDetail(MAT:MatterGuid,69,?,?) Matter investigators detail m-investigator(Position,Field)
m-investigatorcount GetMatContactCount(Mat:MatterGuid,69) The number of investigators on the matter
m-gaol GetMatterContactDetail(MAT:MatterGuid,70,?,?) Matter gaol detail m-gaol(Position,Field)
m-gaolcount GetMatContactCount(Mat:MatterGuid,70) The number of gaols on the matter
m-investor GetMatterContactDetail(MAT:MatterGuid,71,?,?) Matter investor detail m-investor(Position,Field)
m-investorcount GetMatContactCount(Mat:MatterGuid,71) The number of investors on the matter
m-shareholder GetMatterContactDetail(MAT:MatterGuid,72,?,?) Matter shareholder detail m-shareholder(Position,Field)
m-shareholdercount GetMatContactCount(Mat:MatterGuid,72) The number of shareholders on the matter
m-founder GetMatterContactDetail(MAT:MatterGuid,73,?,?) Matter founder detail m-founder(Position,Field)
m-foundercount GetMatContactCount(Mat:MatterGuid,73) The number of founders on the matter
m-subscriber GetMatterContactDetail(MAT:MatterGuid,74,?,?) Matter subscriber detail m-subscriber(Position,Field)
m-subscribercount GetMatContactCount(Mat:MatterGuid,74) The number of subscriber on the matter
m-settlor GetMatterContactDetail(MAT:MatterGuid,75,?,?) Matter settlor detail m-settlor(Position,Field)
m-settlorcount GetMatContactCount(Mat:MatterGuid,75) The number of settlors on the matter
m-trustee GetMatterContactDetail(MAT:MatterGuid,76,?,?) Matter trustee detail m-trustee(Position,Field)
m-trusteecount GetMatContactCount(Mat:MatterGuid,76) The number of trustees on the matter
m-lendor GetMatterContactDetail(MAT:MatterGuid,77,?,?) Matter lendor detail m-lendor(Position,Field)
m-lendorcount GetMatContactCount(Mat:MatterGuid,77) The number of lendors on the matter
m-borrower GetMatterContactDetail(MAT:MatterGuid,78,?,?) Matter borrower detail m-borrower(Position,Field)
m-borrowercount GetMatContactCount(Mat:MatterGuid,78) The number of borrowers on the matter
m-assigner GetMatterContactDetail(MAT:MatterGuid,79,?,?) Matter assigner detail m-assigner(Position,Field)
m-assignercount GetMatContactCount(Mat:MatterGuid,79) The number of assigners on the matter
m-assignee GetMatterContactDetail(MAT:MatterGuid,80,?,?) Matter assignee detail m-assignee(Position,Field)
m-assigneecount GetMatContactCount(Mat:MatterGuid,80) The number of assignees on the matter
sum-w-fcpricedisc CHOOSE(Mat:GSTType=GST:Inclusive,INV:InvoiceTotal+INV:GST-Sum:Disb:PriceIncGST,INV:InvoiceTotal-Sum:Disb:Price)*INV:ForeignCurrencyRate The discounted fees in the invoices in foreign currency
sum-w-fcpriceexdisc (INV:InvoiceTotal-Sum:Disb:Price)*INV:ForeignCurrencyRate The ex-GST discounted fees in the invoices in foreign curren
sum-w-fcpriceincdisc (INV:InvoiceTotal+INV:GST-Sum:Disb:PriceIncGST)*INV:ForeignCurrencyRate The inc-GST disc fees in the invoice in foreighn currency
sum-w-fcgstdisc (INV:GST-Sum:Disb:GST)*INV:ForeignCurrencyRate The disc GST on the fees in the invoice in foreign currency
sum-w-fcpricend Sum:WIP:TotalNoDisc*INV:ForeignCurrencyRate Total of Fees excl any discount items in foreign currency
sum-w-fcpricendex Sum:WIP:TotalNoDiscEx*INV:ForeignCurrencyRate Ex-GST total of Fees excl. any discounts in foreign currency
sum-w-fcpricendinc Sum:WIP:TotalNoDiscInc*INV:ForeignCurrencyRate Inc-GST total of Fees excl. any discounts in foreign currenc
m-classofshares MCM:ClassOfShares Class of shares relating to the matter
m-numshares MCM:NumberOfShares Number of shares relating to the matter
m-consideration MCM:Consideration Consideration relating to the commercial matter
m-briefservdate MCR:BriefServiceDate The brief service date for the matter
m-committaldate MCR:CommittalDate The committal date for the matter
m-replydate MCR:ReplyDate The reply date for the matter
m-juvenile FormatField(MCR:Juvenile,'YesNo','') Is the matter relating to a juvenile
m-waivecommittal FormatField(MCR:WaiverOfCommittal,'YesNo','') Has has a waiver of commital been made for the matter
m-baildate MCR:BailDate The bail date for the matter
m-bailrestrict MCR:BailRestrictions The bail restrictions for the matter
m-outcome MCR:Outcome The outcome of the case for the matter
m-sentencedate MCR:SentencingDate The date of sentencing for the matter
m-sentence MCR:Sentence The sentence applied for the matter
m-s91app FormatField(MCR:S91Application,'YesNo','') Has a S91 application been filed
m-s93app FormatField(MCR:S93Application,'YesNo','') Has a S93 application been filed
mc-addr3 PER:Address3 Address 3 of contact
mc-paddr3 PER:PostalAddress3 Postal Address 3 of the matter contact
mcs-addr3 SOL:Address3 Address 3 of the matter contact solicitor
mcs-paddr3 SOL:PostalAddress3 Postal Address 3 of the matter contact solicitor
f-addr3 CON:Address3 Address 3 of firm
f-paddr3 CON:PostalAddress3 Postal Address 3 of firm
cu-isprincipal FormatField(GetCurrentUserInfo('IsPrincipal'),'YesNo','') Is the current user a principal
m-propaddrwlot GetMatterAddress('1') Matter property address with lot information
m-selcontact GetMatterContactDetail(MAT:MatterGuid,-1,?,?) Matter selected contact detail m-selcontact(Position,Field)
m-instructsol GetMatterContactDetail(MAT:MatterGuid,81,?,?) The details of the instructing solicitor
m-proplot MP:PropLotNumber The Matter property lot number
mc-subject Choose(PER:Gender='M','he',Choose(PER:Gender='F','she','they')) The subject pronoun for the matter contact (he/she/they)
mc-object Choose(PER:Gender='M','him',Choose(PER:Gender='F','her','them')) The object pronoun for the matter contact (him/her/them)
mc-possessive Choose(PER:Gender='M','his',Choose(PER:Gender='F','hers','theirs')) The possessive pronoun for the contact (his/hers/theirs)
mc-reflexive Choose(PER:Gender='M','himself',Choose(PER:Gender='F','herself','themselves')) Reflexive pronoun for contact (himself/herself/themselves)
mc-billingrec GetMatterContactDetail(MAT:MatterGuid,60,?,?) Matter billing recipient detail m-billingrec(Position,Field)
mc-billingreccount GetMatContactCount(Mat:MatterGuid,60) The number of billing recipients on the matter
m-agentsol GetMatterContactDetail(MAT:MatterGuid,82,?,?) The name of the solicitor acting as an agent on the matter
m-agentsolcount GetMatContactCount(Mat:MatterGuid,82) The number of agent solicitors on the matter
r-note INC:Note The note for the receipt
m-accountant GetMatterContactDetail(MAT:MatterGuid,84,?,?) Matter accountant detail m-accountant(Position,Field)
m-superfund GetMatterContactDetail(MAT:MatterGuid,85,?,?) Matter borrower detail m-borrower(Position,Field)
m-superfundcount GetMatContactCount(Mat:MatterGuid,85) The number of superannuation funds on the matter
m-accountantcount GetMatContactCount(Mat:MatterGuid,84) The number of accountants on the matter
i-payurl GetSilqPayURL(INV:InvoiceGuid) The URL for linking to SilqPay for the selected invoice
i-paylink GetSilqPayLinkEmail(INV:InvoiceGuid) The EmaiLink for linking to SilqPay for the selected invoice
i-paylinkword GetSilqPayLinkWord(INV:InvoiceGuid) The WordLink for linking to SilqPay for the selected invoice
m-findate MCV:FinanceDate The date the finance was provided for the matter
m-leaseregnum ML:LeasingRegisteredNumber The registered number of the lease
m-princadv MM:PrincipalAdvanced The amount of the principal advanced in a mortgage matter
m-intrate MM:InterestRate The interest rate of the mortgage
m-commencedate MM:CommencementDate The date the mortgage commenced
m-dischdate MM:DischargeDate The date the mortgage was discharged
m-vessel MVS:VesselName The name of the vessel
m-vessflag MVS:VesselFlag The flag of the vessel
m-vesstype MVS:VesselType The type of the vessel
m-vesstonn MVS:Tonnage The tonnage of the vessel
m-vessmast MVS:VesselMaster The master of the vessel
m-vesslocat MVS:VesselLocation The location of the vessel
me-estlettent FormatField(ME:LettersOfEntitlement,'YesNo','') The matter is applying for letters of entitlement
me-ageatdeath ME:AgeAtDeath The age of the deceased
me-dateofdeath ME:DateOfDeath The date the deceased died
me-deathcertname ME:NameOnDeathCertificate The name on the death certificate
me-addrofdeceased ME:AddressOFDeceased The address of the deceased
me-totalassets ME:TotalAssets The total value of the assets in the estate
me-totalliabilities Me:TotalLiabilities The total of all liabilities in the estate
me-grantno ME:ProbateGrantNo The grant number for probate
me-grantedto ME:ProbateGrantedTo Who probate was granted to
me-publishedin ME:PublishedIn Publication notification was published in
me-publisheddate ME:PublishedDate The date the notification was published
me-distribnoticedate ME:DateOfDistributionNotice The date the notice of distribution was published
me-pagesinwill ME:PagesInwill The number of pages in the will
me-nameinwill ME:NameInWill The name of the deceased in the will
me-marriedafterwill FormatField(ME:MarriedAfterWill,'YesNo','') Whether the deceased was maried after thier will was written
me-marriedtowhom ME:MarriedAfterWillTowhom Whom they married after they made thier will
me-marrieddate ME:DateOfMarriageAfterWill The date the deceased was married after making thier will
me-witness1 ME:Witness1ToCodicil The name of Witness 1 to the codicil
me-witness2 ME:Witness2ToCodicil The name of Witness 2 to the codicil
ea-assettype EA:AssetType The type of the estate asset
ea-value EA:ValueAtDeath The value of the asset at the death of the deceased
ea-interest EA:InterestAccrued The interest accrued on the asset
ea-total EA:TotalValue The total value of the asset
ea-tenancy FormatField(EA:Tenancy,'Tenancy','') The tenancy of the asset
ea-ticshares EA:TenantsInCommonShares The total shares there are for the tenants in common
ea-ticvalue EA:TenantInCommonDeceasedShare The value of the shares for the deceased share
ea-accdesc EA:AccountDescription The description of the account for the asset
ea-accdetail EA:AccountDetails The details of the account for the asset
ea-action EA:AssetAction The action to be taken for this asset
ea-transto EA:TransferredTo Who the asset was transferred to
ea-datetrans EA:DateTransferred The date the asset was transferred
ea-desc EA:AssetDescription The description of the asset
ea-jointtenants EA:JointTenantsDetails The names and addresses of the joint tenants
sum-ea-total Sum:EA:Total Total assets for the estate in the document
sum-ea-sol-total Sum:EA:SOL:Total Total assets held solely by the deceased in the document
sum-ea-tices-total Sum:EA:TICES:Total Total assets held TIC equal shares by the deceased
sum-ea-ticus-total Sum:EA:TICUS:Total Total assets held TIC unequal shares by the deceased
sum-ea-jt-total Sum:EA:JT:Total Total assets held as joint tenants by the deceased
sum-ea-hat-total Sum:EA:HAT:Total Total assets held as trustee by the deceased
sum-ea-hos-total Sum:EA:HOS:Total Total assets held outside of state by the deceased
el-desc EL:LiabilityDescription The description of the liability for the estate
el-date EL:DateIncurred The date the liability was incurred for the estate
el-amount EL:Amount The amount of the liability for the estate
el-secured FormatField(EL:Secured,'YesNo','') Is the estate liability secured
eb-desc EB:EntitlementDescription The description of the beneficiary's entitlement
eb-value EB:ValueOfEntitlement The value if the beneficiary's entitlement
eb-nominal FormatField(EB:NominatlEntitlement,'YesNo','') Is the entitlement for the beneficiary nominal
eb-relationship EB:RelationshipToDeceased The relationship the beneficiary is to the deceased
eb-reline EB:ReLine The RE: line for writing letters to the beneficiary
eb-bank EB:BankName The name of the bank for the beneficiary's account
eb-branch EB:BankBranch The name of the bank branch for the beneficiary's account
eb-accname EB:AccountName The name of the account for the beneficiary
eb-bsb EB:BSBNumber The BSB of the account for the beneficiary
eb-accnum EB:AccountNumber The account number of the account for the beneficiary
eb-distributed FormatField(EB:Distributed,'YesNo','') Has the entitlement been distributed to the beneficiary
eb-notes EB:Notes Addtional notes regarding the beneficiary
mp-volume MP:Volume The volume for the title of the property
mp-volume2 MP:Volume2 The volume for the 2nd title of the property
mp-volume3 MP:Volume3 The volume for the 3rd title of the property
mp-volume4 MP:Volume4 The volume for the 4th title of the property
mp-volume5 MP:Volume5 The volume for the 5th title of the property
mp-folio MP:FolioId The volume for the title of the property
mp-folio2 MP:FolioId2 The volume for the 2nd title of the property
mp-folio3 MP:FolioId3 The volume for the 3rd title of the property
mp-folio4 MP:FolioId4 The volume for the 4th title of the property
mp-folio5 MP:FolioId5 The volume for the 5th title of the property
mp-parvolume MP:ParentVolume The volume of the parent title
mp-parfolio MP:ParentFolioId The Folio Id of the parent title
mp-parlot MP:ParentLot The Lot of the parent title
mp-parplantype MP:ParentPlanType The Plan Type of the parent title
mp-parplanno MP:ParentPlanNumber The Plan Number of the parent title
mp-parsection MP:ParentSection The section of the parent title
mp-parcrallot MP:ParentCrownAllotment The Crown Allotment of the parent title
mp-parcrsect MP:ParentCrownSection The Crown Section of the parent title
mp-parcrblock MP:ParentCrownBlock The Crown Block of the parent title
mp-parcrport MP:ParentCrownPortion The Crown Portion of the parent title
cv-deptype MCV:DepositType
cv-gst MCV:GST
cv-bondexpiry MCV:DepositBondExpiryDate
cv-othconsid MCV:OtherConsideration
cv-coolingdate MCV:CoolingOffDate
cv-conlenvalue MCV:ContractLengthValue
cv-conlentype MCV:ContractLengthPeriodType
cv-concompdate MCV:ContractCompletionDate
cv-concompothdate MCV:ContractCompletionOtherDate
cv-auctiondate MCV:AuctionDate
cv-noticetocompdate MCV:FinalDateForNoticeToComplete
cv-transfeeinc FormatField(MCV:TransferFeesExcluded,'YesNo','')
cv-dupdocs MCV:DuplicateDocuments
cv-duptrans MCV:DuplicateTransfers
cv-enosid MCV:eNOSId
cv-proptype MCV:PropertyType
cv-eligstampdutyreduct FormatField(MCV:EligibleForStampDutyReduction,'YesNo','')
cv-firsthomeowner FormatField(MCV:FirstHomeOwnersGrant,'YesNo','')
cv-exemptpremprop FormatField(MCV:ExemptFromPremiumPropertyDuty,'YesNo','')
cv-newhomegrant FormatField(MCV:NewHomeGrant,'YesNo','')
cv-foreignpurchaser FormatField(MCV:ForeignPurchaser,'YesNo','')
cv-eligpurchpercent MCV:EligiblePurchaserPercentage
cv-dutibleamount MCV:DutibleAmount
cv-addduty MCV:AdditionalDuty
cv-lodgefee MCV:LodgementFee
cv-advalorem MCV:AdValoremFee
cv-totalregfees MCV:TotalRegistrationFees
cv-stampdutydue MCV:StampDutyDueDate
cv-stampdutypaid MCV:StampDutyPaidDate
cv-osrreceipt MCV:OSRReceiptNo
cv-payablevend MCV:PayableByVendor
cv-payablepurch MCV:PayableByPurchaser
cv-chequesdue MCV:ChequesDue
cv-paysforsettle MCV:VendorPays
pa-cmnt USR2:Comment The comment about the assistant on the matter
pa-code USR2:UserId Owner Id of the assistant on the matter
pa-email USR2:Email The email address of the assistant on the matter
pa-fax1 USR2:Fax1 The email address of the assistant on the matter
pa-fax2 USR2:Fax2 The email address of the assistant on the matter
pa-mob USR2:Mobile The mobile phone of the assistant on the matter
pa-name USR2:FullName The full name of the assistant on the matter
pa-ph1 USR2:Phone1 The phone 1 of the assistant on the matter
pa-ph2 USR2:Phone2 The phone 2 of the assistant on the matter
pa-pos USR2:Position The position of the assistant on the matter
pa-praccert USR2:PracticingCertificateNo The practicing cert. number of the assistant of the matter
pa-rpd USR2:RatePerDay The rate per day of the assistant on the matter
pa-rph USR2:RatePerHour The rate per hour of the assistant on the matter
pa-rpu USR2:RatePerHour/GetSystemValue('UnitsPerHour') The rate per unit for the assistant on the matter
pa-user USR2:UserName The username of the assistant on the matter
m-settledate MCV:SettlementDate
m-aggentitle MP:AggregationOfEntitlement The aggregation of the entitlement for the property
m-totalunits MP:TotalUnits The total number of units in a strata plan
m-strataplnum MP:StrataPlanNumber Matter strata plan number
m-asset GetMatterContactDetail(MAT:MatterGuid,86,?,?) The matter Asset detail m-asset(Position,Field)
m-liability GetMatterContactDetail(MAT:MatterGuid,87,?,?) The matter Liability detail m-liability(Position,Field)
m-adjud GetMatterContactDetail(MAT:MatterGuid,88,?,?) The matter Adjudicator detail m-adjud(Position,Field)
m-agedcare GetMatterContactDetail(MAT:MatterGuid,89,?,?) The matter AgedCareFacility detail m-agedcare(Position,Field
m-agentacting GetMatterContactDetail(MAT:MatterGuid,90,?,?) The matter AgentActing detail m-agentacting(Position,Field
m-associate GetMatterContactDetail(MAT:MatterGuid,91,?,?) The matter Associate detail m-associate(Position,Field)
m-ato GetMatterContactDetail(MAT:MatterGuid,92,?,?) The matter ATO detail m-ato(Position,Field)
m-auditor GetMatterContactDetail(MAT:MatterGuid,93,?,?) The matter Auditor detail m-auditor(Position,Field)
m-bodycorp GetMatterContactDetail(MAT:MatterGuid,94,?,?) The matter BodyCorporate detail m-bodycorp(Position,Field)
m-builder GetMatterContactDetail(MAT:MatterGuid,95,?,?) The matter Builder detail m-builder(Position,Field)
m-buildinspect GetMatterContactDetail(MAT:MatterGuid,96,?,?) The matter BuildingInspector detail m-buildinginsp(Pos,Fld)
m-businessowner GetMatterContactDetail(MAT:MatterGuid,97,?,?) The matter BusinessOwner detail m-businessowner(Pos,Fld)
m-carer GetMatterContactDetail(MAT:MatterGuid,98,?,?) The matter Carer detail m-carer(Position,Field)
m-caveator GetMatterContactDetail(MAT:MatterGuid,99,?,?) The matter Caveator detail m-caveator(Position,Field)
m-consultant GetMatterContactDetail(MAT:MatterGuid,100,?,?) The matter Consultant detail m-consultant(Position,Field)
m-contsecprov GetMatterContactDetail(MAT:MatterGuid,100,?,?) The matter ContSecurityProvider detail m-contsecurityprov(P,
m-costassessor GetMatterContactDetail(MAT:MatterGuid,101,?,?) The matter CostAssessor detail m-costassessor(Position,Fld)
m-council GetMatterContactDetail(MAT:MatterGuid,102,?,?) The matter Council detail m-council(Position,Field)
m-director GetMatterContactDetail(MAT:MatterGuid,103,?,?) The matter Director detail m-director(Position,Field)
m-dischmort GetMatterContactDetail(MAT:MatterGuid,104,?,?) The matter DischargingMortgagee detail m-dischmort(Pos,Fld)
m-electcomp GetMatterContactDetail(MAT:MatterGuid,105,?,?) The matter ElectricityCompany detail m-electcomp(Pos,Fld)
m-father GetMatterContactDetail(MAT:MatterGuid,106,?,?) The matter Father detail m-father(Position,Field)
m-fininstitution GetMatterContactDetail(MAT:MatterGuid,107,?,?) The matter FinancialInstitution detail m-fininstitution(P,F)
m-finplanner GetMatterContactDetail(MAT:MatterGuid,108,?,?) The matter FinancialPlanner detail m-finplanner(Pos,Field)
m-frachisesystem GetMatterContactDetail(MAT:MatterGuid,109,?,?) The matter FranchiseSystem detail m-franchisesystem(Pos,Fld)
m-franchisee GetMatterContactDetail(MAT:MatterGuid,110,?,?) The matter Franchisee detail m-franchisee(Position,Field)
m-franchisor GetMatterContactDetail(MAT:MatterGuid,111,?,?) The matter Franchisor detail m-franchisor(Position,Field)
m-funeraldir GetMatterContactDetail(MAT:MatterGuid,112,?,?) The matter FuneralDirector detail m-funeraldir(Pos,Field)
m-govdept GetMatterContactDetail(MAT:MatterGuid,113,?,?) The matter GovernmentDepartment detail m-govdept(Pos,Fld)
m-guarantor GetMatterContactDetail(MAT:MatterGuid,114,?,?) The matter Guarantor detail m-guarantor(Position,Field)
m-guardian GetMatterContactDetail(MAT:MatterGuid,115,?,?) The matter Guardian detail m-guardian(Position,Field)
m-policeofficer GetMatterContactDetail(MAT:MatterGuid,116,?,?) The matter PoliceOfficer detail m-policeofficer(Pos,Fld)
m-incomingcovenator GetMatterContactDetail(MAT:MatterGuid,117,?,?) The matter IncomingCovenator detail m-incomingcovenator(P,F)
m-incomingmortgagee GetMatterContactDetail(MAT:MatterGuid,118,?,?) The matter IncomingMortgagee detail m-incomingmortgagee(P,F)
m-industialreg GetMatterContactDetail(MAT:MatterGuid,119,?,?) The matter IndustrialRegistry detail m-industrialreg(Pos,Fd)
m-insured GetMatterContactDetail(MAT:MatterGuid,120,?,?) The matter Insured detail m-insured(Position,Field)
m-judgementcreditor GetMatterContactDetail(MAT:MatterGuid,121,?,?) The matter JudgementCreditor detail m-judgementcreditor(P,F)
m-landtitlesoffice GetMatterContactDetail(MAT:MatterGuid,122,?,?) The matter LandTitlesOffice detail m-landtitlesoffice(Pos,F)
m-landlord GetMatterContactDetail(MAT:MatterGuid,123,?,?) The matter Landlord detail m-landlord(Position,Field)
m-legalaid GetMatterContactDetail(MAT:MatterGuid,124,?,?) The matter LegalAid detail m-legalaid(Position,Field)
m-lessee GetMatterContactDetail(MAT:MatterGuid,125,?,?) The matter Lessee detail m-lessee(Position,Field)
m-lettingagent GetMatterContactDetail(MAT:MatterGuid,126,?,?) The matter LettingAgent detail m-lettingagent(Position,Fld)
m-liquidator GetMatterContactDetail(MAT:MatterGuid,127,?,?) The matter Liquidator detail m-liquidator(Position,Field)
m-listingagent GetMatterContactDetail(MAT:MatterGuid,128,?,?) The matter ListingAgent detail m-listingagent(Position,Fld)
m-manager GetMatterContactDetail(MAT:MatterGuid,129,?,?) The matter Manager detail m-manager(Position,Field)
m-managingagent GetMatterContactDetail(MAT:MatterGuid,130,?,?) The matter ManagingAgent detail m-managingagent(Pos,Fld)
m-mediator GetMatterContactDetail(MAT:MatterGuid,131,?,?) The matter Mediator detail m-mediator(Position,Field)
m-memberoforg GetMatterContactDetail(MAT:MatterGuid,132,?,?) The matter MemberOfOrganisation detail m-memberoforg(Pos,Fd)
m-mother GetMatterContactDetail(MAT:MatterGuid,133,?,?) The matter Mother detail m-mother(Position,Field)
m-nursinghome GetMatterContactDetail(MAT:MatterGuid,134,?,?) The matter NursingHome detail m-nursinghome(Position,Field)
m-occupier GetMatterContactDetail(MAT:MatterGuid,135,?,?) The matter Occupier detail m-occupier(Position,Field)
m-opponent GetMatterContactDetail(MAT:MatterGuid,136,?,?) The matter Opponent detail m-opponent(Position,Field)
m-gascompany GetMatterContactDetail(MAT:MatterGuid,137,?,?) The matter GasCompany detail m-gascompany(Position,Field)
m-partner GetMatterContactDetail(MAT:MatterGuid,138,?,?) The matter Partner detail m-partner(Position,Field)
m-policestation GetMatterContactDetail(MAT:MatterGuid,139,?,?) The matter PoliceStation detail m-policestation(Pos,Fld)
m-previoussolicitor GetMatterContactDetail(MAT:MatterGuid,140,?,?) The matter PreviousSolicitor detail m-previoussolicitor(P,F)
m-principal GetMatterContactDetail(MAT:MatterGuid,141,?,?) The matter Principal detail m-principal(Position,Field)
m-processserver GetMatterContactDetail(MAT:MatterGuid,142,?,?) The matter ProcessServer detail m-processserver(Pos,Fld)
m-proprietor GetMatterContactDetail(MAT:MatterGuid,143,?,?) The matter Proprietor detail m-proprietor(Position,Field)
m-psychologist GetMatterContactDetail(MAT:MatterGuid,144,?,?) The matter Psychologist detail m-psychologist(Position,Fld)
m-publicofficer GetMatterContactDetail(MAT:MatterGuid,145,?,?) The matter PublicOfficer detail m-publicofficer(Position,Fd)
m-receiver GetMatterContactDetail(MAT:MatterGuid,146,?,?) The matter Receiver detail m-receiver(Position,Field)
m-referrer GetMatterContactDetail(MAT:MatterGuid,147,?,?) The matter Referrer detail m-referrer(Position,Field)
m-relative GetMatterContactDetail(MAT:MatterGuid,148,?,?) The matter Relative detail m-relative(Position,Field)
m-renouncedexecutor GetMatterContactDetail(MAT:MatterGuid,149,?,?) The matter RenouncedExecutor detail m-renouncedexecutor(P,F)
m-revenueoffice GetMatterContactDetail(MAT:MatterGuid,150,?,?) The matter RevenueOffice detail m-revenueoffice(Position,Fd)
m-secretary GetMatterContactDetail(MAT:MatterGuid,151,?,?) The matter Secretary detail m-secretary(Position,Field)
m-securedcreditor GetMatterContactDetail(MAT:MatterGuid,152,?,?) The matter SecuredCreditor detail m-securedcreditor(Pos,Fld)
m-securityprovider GetMatterContactDetail(MAT:MatterGuid,153,?,?) The matter SecurityProvider detail m-securityprovider(Pos,F)
m-settlementagent GetMatterContactDetail(MAT:MatterGuid,154,?,?) The matter SettlementAgent detail m-settlementagent(Pos,Fld)
m-sheriff GetMatterContactDetail(MAT:MatterGuid,155,?,?) The matter Sheriff detail m-sheriff(Position,Field)
m-stockbroker GetMatterContactDetail(MAT:MatterGuid,156,?,?) The matter Stockbroker detail m-stockbroker(Position,Field
m-superintendant GetMatterContactDetail(MAT:MatterGuid,157,?,?) The matter Superintendant detail m-superintendant(Pos,Fld)
m-suppattorney GetMatterContactDetail(MAT:MatterGuid,158,?,?) The matter SupportiveAttorney detail m-suppattorney(Pos,Fld)
m-surveyor GetMatterContactDetail(MAT:MatterGuid,159,?,?) The matter Surveyor detail m-surveyor(Position,Field)
m-townplanner GetMatterContactDetail(MAT:MatterGuid,160,?,?) The matter TownPlanner detail m-townplanner(Position,Field
m-trademarkagent GetMatterContactDetail(MAT:MatterGuid,161,?,?) The matter TradeMarkAgent detail m-trademarkagent(Pos,Fld)
m-tribunalcomm GetMatterContactDetail(MAT:MatterGuid,162,?,?) The matter Tribunal_Commission detail m-tribunalcomm(Pos,Fld
m-vendorsacc GetMatterContactDetail(MAT:MatterGuid,163,?,?) The matter VendorsAccountant detail m-vendorsacc(Pos,Fld)
m-willmaker GetMatterContactDetail(MAT:MatterGuid,164,?,?) The matter Willmaker detail m-willmaker(Position,Field)
m-officerincharge GetMatterContactDetail(MAT:MatterGuid,165,?,?) The matter OfficerinCharge detail m-officerincharge(Pos,Fld)
m-employee GetMatterContactDetail(MAT:MatterGuid,166,?,?) The matter Employee detail m-employee(Position,Field)
m-shareregistry GetMatterContactDetail(MAT:MatterGuid,167,?,?) The matter ShareRegistry detail m-shareregistry(Pos,Fld)
m-sharebroker GetMatterContactDetail(MAT:MatterGuid,168,?,?) The matter ShareBroker detail m-sharebroker(Position,Field)
m-waterauthority GetMatterContactDetail(MAT:MatterGuid,169,?,?) The matter WaterAuthority detail m-waterauthority(Pos,Fld)
m-judge GetMatterContactDetail(MAT:MatterGuid,170,?,?) The matter Judge detail m-judge(Position,Field)
m-vendorsagent GetMatterContactDetail(MAT:MatterGuid,171,?,?) The matter VendorsAgent detail m-vendorsagent(Position,Fld)
m-coagent GetMatterContactDetail(MAT:MatterGuid,172,?,?) The matter CoAgent detail m-coagent(Position,Field)
s-famlawid GetSystemValue('FamilyLawCourtId') The family law court id for the firm
i-disb INV:DisbursementAmountIncGST The total amount of disbursements on an invoice
i-disbex INV:DisbursementAmountExGST The total amount of disbursements (ex-gst) on an invoice
i-fees INV:InvoiceTotal+INV:GST-INV:DisbursementAmountIncGST The total amount of fees on an invoice
i-feesex INV:InvoiceTotal-INV:DisbursementAmountExGST The total amount of fees (ex-gst) on an invoice
m-isrepapplic Yes|No If you're representing the Applicant or Respondent.
m-isrephusb Yes|No If you're representing the husband.
sa-pbal MCV:PurchasePrice - MCV:DepositAmount + Sum:SA:PurchAmount Purchaser payable allowances with balance
m-regplan GetMatterRegisteredPlan() The registered plan number(s) for the matter
m-commitymgr GetMatterContactDetail(MAT:MatterGuid,173,?,?) The matter community mgr detail m-communitymgr(Pos,Fld)
s-lrsboxno GetSystemValue('LRSBoxNumber') The Land Registry Services Box Number for the firm
time Clock() The current time of day
dr-debtamount MDR:DebtAmount The matter debt recovery base amount
dr-duedate MDR:DebtDueDate The matter debt recovery due date
dr-intrate MDR:InterestRate The matter debt recovery interest rate
dr-entenddate MDR:InterestEndDate The matter debt recovery end date for interest
dr-inttodate MDR:InterestToDate The matter debt recovery interest so far
dr-fileingfees MDR:FilingFees The matter debt recovery filing fees
dr-servicefees MDR:ServiceFees The matter debt recovery service fees
dr-solfees MDR:SolicitorsFees The matter debt recovery solicitor fees
dr-totaldebt MDR:TotalDebt The matter debt recovery total including fees
dr-amountrecovered MDR:AmountRecovered The matter debt recovery amount recovered
dr-balowing MDR:BalanceOwing The matter debt recovery balance owing
dr-defjudgedate MDR:DefaultJudgementDate The matter debt recovery default judgement date
dr-djintrate MDR:DJInterestRate The matter debt recovery DJ Interest rate
dr-intsincedj MDR:InterestSinceDefaultJudgement The matter debt recovery interest since DJ
dr-addservfees MDR:AdditionalServiceFees The matter debt recovery additional services fees
dr-garnisheetotal MDR:GarnisheeTotal The matter debt recovery garnishee total
dr-reviewdate MDR:ReviewDate The matter debt recovery review date
dr-repaydetails MDR:RepaymentDetails The matter debt recovery repayment details
dr-finalpaydate MDR:FinalPaymentDate The matter debt recovery final payment date
s-mob GetSystemValue('Mobile') The mobile phone of the practice
m-reline GetMatterReLine() The Re: line for a matter including client name etc
m-icl GetMatterContactDetail(MAT:MatterGuid,174,?,?) The matter Indpependent childrens lawyer m-icl(Pos,Field)
i-outlessalltrust Choose(INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,0)<0,0,INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,0)) The amount outstanding less the trust & controlled balances
i-outlesscontrol Choose(INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,2)<0,0,INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,2)) The amount outstanding less the controlled money balance
i-outlesstrust Choose(INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,1)<0,0,INV:AmountOutstandingIncGST - GetMatterTrustBalance(Mat:MatterGuid,1)) The amount outstanding less the trust ledger balance
m-otherside GetMatterContactDetail(MAT:MatterGuid,83,?,?) Matter other side detail m-otherside(Pos,Field)
m-actingfor GetMatterActingForDetail(MAT:MatterGuid,?,?) The details of the contact that they are acting for
m-actingagainst GetMatterActingAgainstDetail(MAT:MatterGuid,?,?) The details of the contact that they are acting against
w-pricenc Choose(WKI:Price=0,'No Charge',Format(Choose(WKI:InvoiceGuid~='',CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGSTCharged,WKI:PriceCharged),CHOOSE(Mat:GSTType=GST:Inclusive,WKI:PriceIncGST,WKI:Price)),@n$17.2)) Price of WIP/Disbursement Item - "No Charge" if 0
w-priceexnc Choose(WKI:Price=0,'No Charge',Format(Choose(WKI:InvoiceGuid~='',WKI:PriceCharged,WKI:Price),@n$17.2)) Ex GST Price of WIP/Disbursement Item - "No Charge" if 0
w-priceincnc Choose(WKI:PriceIncGST=0,'No Charge',Format(Choose(WKI:InvoiceGuid~='',WKI:PriceIncGSTCharged,WKI:PriceIncGST),@n17.2)) Inc GST Price of WIP/Disbursement Item - "No Charge" if 0
m-subexec GetMatterContactDetail(MAT:MatterGuid,175,?,?) The matter substitute executor detail m-subexec(Pos,Fld)
m-altattorney GetMatterContactDetail(MAT:MatterGuid,177,?,?) The matter alternate attorney detail m-altattorney(Pos,Fld)
m-altguardian GetMatterContactDetail(MAT:MatterGuid,178,?,?) The matter alternate guardian detail m-altguardian(Pos,Fld)
m-attorney GetMatterContactDetail(MAT:MatterGuid,176,?,?) The matter attorney detail m-attorney(Pos,Fld)
m-class FormatField(Mat:MatterClass,'Class','') The matter class for the selected matter
mc-possessive2 Choose(PER:Gender='M','his',Choose(PER:Gender='F','her','their')) The possessive present pronoun for contact (his/her/their)
el-amountsec Choose(EL:Secured,EL:Amount,0) The estate liabilty amount if it is secured
el-amountunsec Choose(EL:Secured,0,EL:Amount) The estate liabilty amount if it is unsecured
mc-age Choose(PER:DateOfBirth>0,INT((Today()-PER:DateOFBirth)/365.24),0) The age of the contact
mc-ageifminor Choose(PER:DateOfBirth>0,Choose(INT((Today()-PER:DateOfBirth)/365.24)<18,INT((Today()-PER:DateOfBirth)/365.24),0),0) The age of the person if they are a minor (under 18)
mc-isminor Choose(PER:DateOfBirth>0,Choose(INT((Today()-PER:DateOfBirth)/365.24)<18,'Yes','No'),'No') Is the contact a minor
mc-bestname GetPersonBestName() The best name of the person. (First/Middle/Last)
i-disbgst INV:DisbursementAmountIncGST-INV:DisbursementAmountExGST The total amount of GST on disbursements on an invoice
i-feesgst INV:GST-(INV:DisbursementAmountIncGST-INV:DisbursementAmountExGST) The total amount of GST on fees on an invoicen invoice
i-overdue Choose(today()>INV:DueDate,1,0) Is the invoice overdue.
sum-w-priceld Sum:WIP:TotalNoDisc-Sum:WIP:Discounts The total of Fees less disccount any discount items
sum-w-priceldex Sum:WIP:TotalNoDiscEx-Sum:WIP:DiscountsEx The Ex-GST total of Fees less disccount any discount items
sum-w-priceldinc Sum:WIP:TotalNoDiscInc-Sum:WIP:DiscountsInc The Ex-GST total of Fees less disccount any discount items
count-dsic Count:Disc Count of the number of items in a Multi:Disc
sum-w-fcpriceld (Sum:WIP:TotalNoDisc-Sum:WIP:Discounts)*INV:ForeignCurrencyRate The total of Fees less disccount in foreign currency
sum-w-fcpriceldex (Sum:WIP:TotalNoDiscEx-Sum:WIP:DiscountsEx)*INV:ForeignCurrencyRate The Ex-GST of Fees less any discount in foreign currency
sum-w-fcpriceldinc (Sum:WIP:TotalNoDiscInc-Sum:WIP:DiscountsInc)*INV:ForeignCurrencyRate The Inc-GST of Fees less any discount in foreign currency
cu-emailsignature GetCurrentUserInfo('EmailSignature') The HTML signature of the currently logged on user
mc-parentaddr GetContactParentStreetAddress('') Street Address of the parent/company contact
mc-parentaddrnl GetContactParentStreetAddress('1') Street Address of the parent/company contact with new lines
mc-parentpostal GetContactParentPostalAddress('') Street Address of the parent/company contact
mc-parentpostalnl GetContactParentPostalAddress('1') Street Address of the parent/company contact with new lines
i-truststmnt GenerateTrustStatement(MAT:MatterGuid) Generate Individual Trust Statement
i-outfromtrust Choose(GetMatterTrustBalance(Mat:MatterGuid,1) > (INV:InvoiceTotal+INV:GST), (INV:InvoiceTotal+INV:GST),GetMatterTrustBalance(Mat:MatterGuid,1)) How much of an invoice can be paid from trust
m-childguardsub GetMatterContactDetail(MAT:MatterGuid,179,?,?) The matter children's guardians substitute (Pos,Fld)
m-childguardsubcount GetMatContactCount(Mat:MatterGuid,179) The number of children's guardian substitutes on the matter
m-testamentarytrustee GetMatterContactDetail(MAT:MatterGuid,180,?,?) The matter testamentary trustee detail (Pos,Fld)
m-testamentarytrusteecount GetMatContactCount(Mat:MatterGuid,180) The number of testamentary trustees on the matter
m-testamentarytrusteesub GetMatterContactDetail(MAT:MatterGuid,181,?,?) The matter testamentary trustee substitute detail (Pos,Fld)
m-testamentarytrusteesubcount GetMatContactCount(Mat:MatterGuid,181) The number of testamentary trustee substitutes on the matter
m-husbandendfinatt GetMatterContactDetail(MAT:MatterGuid,182,?,?) The matter husband's enduring financial attorney (Pos, Fld)
m-husbandendfinattcount GetMatContactCount(Mat:MatterGuid,182) The number of husband's enduring financial attorneys on the
m-husbandendfinattsub GetMatterContactDetail(MAT:MatterGuid,183,?,?) The matter husband's enduring financial attorney substitute
m-husbandendfinattsubcount GetMatContactCount(Mat:MatterGuid,183) The number of husband's enduring financial attorney subs
m-husbandendguard GetMatterContactDetail(MAT:MatterGuid,184,?,?) The matter husband's enduring guardian detail (Pos, Fld)
m-husbandendguardcount GetMatContactCount(Mat:MatterGuid,184) The number of husband's enduring guardians on the matter
m-husbandendguardsub GetMatterContactDetail(MAT:MatterGuid,185,?,?) The matter husband's enduring guardian substitute detail(P,F
m-husbandendguardsubcount GetMatContactCount(Mat:MatterGuid,185) The number of husband's enduring guardian substitutes on the
m-wifeendfinatt GetMatterContactDetail(MAT:MatterGuid,186,?,?) The matter wife's enduring financial attorney detail (P,F)
m-wifeendfinattcount GetMatContactCount(Mat:MatterGuid,186) The number of wife's enduring guardian financial attorneys o
m-wifeendfinattsub GetMatterContactDetail(MAT:MatterGuid,187,?,?) The matter wife's enduring financial attorney substitute det
m-wifeendfinattsubcount GetMatContactCount(Mat:MatterGuid,187) The number of wife's enduring financial attorney subsitutes
m-wifeendguard GetMatterContactDetail(MAT:MatterGuid,188,?,?) The matter wife's enduring guardian detail (Pos, Fld)
m-wifeendguardcount GetMatContactCount(Mat:MatterGuid,188) The number of wife's enduring guardians on the matter
m-wifeendguardsub GetMatterContactDetail(MAT:MatterGuid,189,?,?) The matter wife's enduring guardian substitute detail (P,F)
m-wifeendguardsubcount GetMatContactCount(Mat:MatterGuid,189) The number of wife's enduring guardian substitutes on the ma
m-specgiftbene GetMatterContactDetail(MAT:MatterGuid,190,?,?) The matter specific gift beneficiary m-specgiftbene (P,F)
m-specgiftbenecount GetMatContactCount(Mat:MatterGuid,190) The number of specific gift beneficiaries on the matter
m-residuarybene GetMatterContactDetail(MAT:MatterGuid,191,?,?) The matter residuary beneficiary detail m-residuarybene(P,F)
m-residuarybenecount GetMatContactCount(Mat:MatterGuid,191) The number of residuary beneficiaries on the matter
m-superbene GetMatterContactDetail(MAT:MatterGuid,192,?,?) The matter superannuation beneficiary detail m-superbene(P,F
m-superbenecount GetMatContactCount(Mat:MatterGuid,192) The number of superannuation beneficiaries on the matter
m-superbenesub GetMatterContactDetail(MAT:MatterGuid,193,?,?) The matter superannuation beneficiary substitute detail (P,F
m-superbenesubcount GetMatContactCount(Mat:MatterGuid,193) The number of superannuation beneficiary substitutes on the
m-newtrustee GetMatterContactDetail(MAT:MatterGuid,194,?,?) The matter new trustee detail m-newtrustee (Pos, Fld)
m-newtrusteecount GetMatContactCount(Mat:MatterGuid,194) The number of new trustees on the matter
m-appointor GetMatterContactDetail(MAT:MatterGuid,195,?,?) The matter appointor m-appointor (Pos, Fld)
m-appointorcount GetMatContactCount(Mat:MatterGuid,195) The number of appointors on the matter
m-appointorsub GetMatterContactDetail(MAT:MatterGuid,196,?,?) The matter appointor substitute m-appointorsub (Pos, Fld)
m-appointorsubcount GetMatContactCount(Mat:MatterGuid,196) The number of appointor substitutes on the matter
m-pwrofattrny GetMatterContactDetail(MAT:MatterGuid,197,?,?) The matter power of attorney detail m-pwrofattrny (Pos,Fld)
m-pwrofattrnycount GetMatContactCount(Mat:MatterGuid,197) The number of power of attorneys on the matter
m-pwrofattrnysub GetMatterContactDetail(MAT:MatterGuid,198,?,?) The matter power of attorney substitute on the matter (P,F)
m-pwrofattrnysubcount GetMatContactCount(Mat:MatterGuid,198) The number of power of attorney substitutes on the matter
m-endguardsub GetMatterContactDetail(MAT:MatterGuid,199,?,?) The matter enduring guardian substitute detail m-endguardsub
m-endguardsubcount GetMatContactCount(Mat:MatterGuid,199) The number of enduring guardian substitutes on the mtter
m-testator GetMatterContactDetail(MAT:MatterGuid,200,?,?) The matter testator detail m-testator (Position, Field)
m-testatorcount GetMatContactCount(Mat:MatterGuid,200) The number of testators on the matter
m-testatrix GetMatterContactDetail(MAT:MatterGuid,201,?,?) The matter testatrix detail m-testatrix (Position, Field)
m-testatrixcount GetMatContactCount(Mat:MatterGuid,201) The number of testatrix on the matter
cu-offlocation GetCurrentUserInfo('OfficeLocation') The office location of the current user
cu-offdesc GetCurrentUserInfo('OfficeDescription') The office description of the current user
fe-offlocation USR:OfficeLocation The office location of the fee earner
fe-offdesc USR:OfficeDescription The office description of the fee earner
ow-offlocation USR1:OfficeLocation The office location of the owner of the matter
ow-offdesc USR1:OfficeDescription The office description of the owner of the matter
pa-offlocation USR2:OfficeLocation The office location of the person assisting the matter
pa-offdesc USR2:OfficeDescription The office description of the owner of the matter
m-cmppwrofattrny GetMatterContactDetail(MAT:MatterGuid,202,?,?) The matter company power of attorney detail m-cmppwrofattrny
m-cmppwrofattrnycount GetMatContactCount(Mat:MatterGuid,202) The number of company power of attorneys on the matter
m-cmpgenfinattrny GetMatterContactDetail(MAT:MatterGuid,203,?,?) The matter company general financial attorney detail (P,F)
m-cmpgenfinattrnycount GetMatContactCount(Mat:MatterGuid,203) The number of company general financial attorneys on the mat
m-familytrust GetMatterContactDetail(MAT:MatterGuid,204,?,?) The matter family trust detail m-familytrust (Pos,Fld)
m-familytrustcount GetMatContactCount(Mat:MatterGuid,204) The number of family trust on the matter
w-hasgst Choose(WKI:GSTCharged>0,'*','') Shows an asterix if the item has GST, else shows nothing
w-nc Choose(WKI:Price=0,'[Not Charged]','') Displays the text [Not Charged] if the item price is zero
today+14 today()+14 Todays Date plus 14 days
today+7 today()+7 Todays Date plus 7 days
w-qtyu2m FormatQuantity(WKI:ItemType,WKI:Quantity,WKI:QuantityType,WKI:FeeType,'4') Formatted Quantity of WIP/Disbursement conv. units to minute
m-offensedate MCR:OffenceDate The offence date for the matter
m-custodyno MCR:CustodyNumber The Custody number for a criminal matter
m-custodylocation MCR:CustodyLocation The Custody location for a criminal matter
m-offincharge MCR:OfficerInCharge The officer in charge for a criminal matter
m-chargenumber MCR:ChargeNumber The charge number for a criminal matter
m-criminalnameindex MCR:CriminalNameIndex The criminal name index for a criminal matter
m-legalaidreference MCR:LegalAidReference The legal aid reference for a criminal matter
cv-settletime MCV:SettlementTime The time of the settlement
cv-settlelocation MCV:SettlementLocation The location of the settlement
m-fard MAT:FeeAgreementReceivedDate Date that the fee agreement was received for this matter
m-lastreviewdate MAT:LastReviewDate Last review date for this matter
m-matstatus MAT:MatterStatus The status for this matter
  Back to top