Schema reference

The Efimis ETL schema defines staging tables for every importable entity.

Concepts

ImportId

Every object has an ImportId property — a string that uniquely identifies each item being imported. When importing from an external system, populate it with the source system’s ID, or generate a new one.

To reference an object already imported (e.g. adding a work item to an existing matter), use the format prefix_uniqueid, for example matter_22635a10c993592cb52c083f346aa950.

---

Account

Note: Efimis will be provisioned with a default chart of accounts.

Property	Description	Type	Example
Name		string
Description		string
JournalId		string
ParentAccountId		string
Type		AccountType
AccountRoles	Not Supported Yet	IList<AccountRole>
AccountCategory		AccountCategory
AccountCode		string
BankName		string
BankBSB		string
BankAccountNumber		string
TaxCode		string
Currency	Currency for this account. If not specified, the base currency is assumed	string?	GBP, AUD
Balance		decimal	200.38

AccountCategory

Property	Description	Value
Asset	Asset	0
Liability	Liability	1
Equity	Equity	2
Revenue	Revenue	3
Expense	Expenses	4

AccountRole

Property	Description	Value
Unallocated	Catch all account	0
UnbankedFunds	Unbanked Funds	1
AccountsReceivable	Accounts Receivable	2
DebtorsAdjustment	Debtors Adjustment	3
AccountsPayable	Accounts Payable	4
CreditorsAdjustment	Creditors Adjustment	5
SupplierPrepayments	Advance payments to supplier for future purchases	6
SupplierCredits	Supplier issued non-cash credit notes, i.e. discounts taken	7
Disbursement	Disbursement Incurred	8
DisbursementRecovered	Disbursement Recovered	9
AnticipatedDisbursement	Anticipated Disbursement Incurred	10
AnticipatedDisbursementRecovered	Anticipated Disbursement Recovered	11
ClientFunds	Client advanced payments for future invoices	12
CreditNotes	Firm issued non-cash credits, i.e. vouchers or gift cards	13
TaxCollected	Tax Collected	14
TaxPaid	Tax Paid	15
CmaControl	Controlled Monies control account, lives in the trust journal only	16
StatDepositControl	Applicable only to some jurisdictions, the control account for all monies held with the statutory body	17
RetainedEarnings	Retained Earnings	18
CurrentEarnings	Current Earnings	19
HistoricalBalance	Historical Balance	20
FeesRevenue	Professional fees revenue recognised on invoices when finalised, inclusive of discount	21
CostRecovered	Cost recovery revenue recognised on invoices when finalised	22
DiscountTaken	Discount taken from supplier when a discount is received	23
RealisedFxGain	Captures gains and losses due to exchange rate difference between when debtor/credit is posted, and when they are paid	24
UnrealisedFxGain	Captures gains and losses due to exchange rate difference between the reporting time, and posting time	25
RoundingAdjustment	When working with tax, forex, rounding errors occur when numbers cannot be divided completely	26
CreditNotesIssued	Does not include discount line items — they are considered a reduction of FeesRevenue	27
FeesWrittenOff	Fees Written Off	28
DisbursementsWrittenOff	Disbursements Written Off	29
CostRecoveryWrittenOff	Cost Recovery Written Off	30
AnticipatedDisbWrittenOff	Anticipated Disbursement Written Off	31
OtherRevenue	Miscellaneous revenue items on the invoice, such as interest earned or credit card surcharge	32
OtherRevenueWrittenOff	Other Revenue and other GL revenue items invoiced being written off	33
ProBonoFeesExpenses	Account to track fees on pro-bono matters	34
ProBonoDisbursementsExpenses	Account to track disbursements on pro-bono matters	35
ProBonoAnticipatedDisbursementsExpenses	Account to track anticipated disbursements on pro-bono matters	36
ProBonoCostRecoveryExpenses	Account to track cost recovery disbursements on pro-bono matters	37

AccountType

Property	Description	Value
Standard	Standard GL account with no special behaviour	0
Bank	A GL account that mirrors a bank account and may participate in cashbook operations	1

---

Address

Property	Description	Type	Example
AttentionOf		string
AddressType		AddressType
Street		string
Locality		string
Suburb		string
State		string
PostCode		string
Country		string
Name	Optional name to identify this address, e.g. Spouse Address	string
Notes	Optional additional information on how this address should be used	string
Default		bool	true, false

AddressType

Property	Description	Value
Billing	Billing	0
Postal	Postal	1
Street	Street address	2
Other	Other	3

---

Association

Property	Description	Type	Example
Type		string
EntityId		string

---

BankAccountDetails

Property	Description	Type	Example
RoutingCode		string
BranchCode		string
Number		string
Name		string
BankName		string
BranchName		string

---

BillingBasis

All the different ways billing is done on matters.

Property	Description	Value
AdHoc	Matter has to be marked as billing for it to be included in the automated billing run	0
Periodic	Matter will be billed periodically according to the firm default billing schedule	1
ProBono	Matter will not be included in any billing, and marked as pro bono work	2
NonBillable	Matter will not be included in any billing, and marked as internal admin matter	3

---

BillingGrade

Property	Description	Type	Example
Name		string

---

BillingRate

This represents a rate definition on a Matter or Employee.

Property	Description	Type	Example
Name		string
RateSetName		string?
Rate	The hourly rate	decimal	200.38
MatterId		string?
EmployeeId		string?
Memo		string
EffectiveFrom		DateTime?	2025-01-12T00:00:00
EffectiveTo		DateTime?	2025-01-12T00:00:00

---

CashbookAccount

Specifies a cashbook account that tracks a bank account.

Property	Description	Type	Example
JournalId		string
AccountName	Name used by the user to identify it	string
BookBalance	Cashbook balance as at cutover time	decimal	200.38
ReconciledBalance	Reconciled cashbook balance as at cutover time	decimal	200.38
BankRoutingCode	The unique identifier used by the banking system at large to identify international transfer accounts IBAN/Swift	string?
BankBranchCode	The Branch code of the bank	string?
BankAccountNumber	Account number issued by the bank	string?
BankAccountName	Account name known by the bank	string?
BankName	Financial institution name	string?
BankBranchName	Branch name	string?
StatDepositBalance	Stat Deposit Balance as at cutover time. Applicable to Australian firms only	decimal?	200.38

---

CashDetail

Property	Description	Type	Example
AmountInNotes		decimal	200.38
AmountInCoins		decimal	200.38

---

Client

Property	Description	Type	Example
EntityId		string
State		ClientState
ClientNumber		string
Currency	Currency this client deals in (inherited from Entity)	string
TaxCode	The default tax code applicable to this client	string
RateSetId		string
OverrideRateSetId		string
BillingContactId	Billing contact for invoices and financials to be sent to	string
BillingBasis	Method by which billing is done on this matter	BillingBasis?
BillingChannel	How does the client like to receive invoices?	ContactChannel
MarketingChannel	Which marketing channel did this client come through	string
IntroducerId	The employee who introduced this client to the firm	string
ReferrerId	Details about the external source that referred this client to the firm	ReferrerDetails?
Notes		string
AutoGenerateStatements	Whether to automatically email the Statement of Account to the client based on the configured schedule	bool	true, false

ClientState

Property	Description	Value
Draft	In the process of creating	0
Active	Identity verified	1
Held	No work can be done for this client	2
Closing	In the process of being closed	3
Closed	No longer acting	4

---

CmaAccount

Property	Description	Type	Example
DisplayName	User friendly account name	string
MatterId	The matter this CMA or investment account belongs to	string
AccountType	Controlled Money, or Investment	CmaAccountType
Description	Additional info regarding this CMA or investment account	string
State		CmaAccountState
Currency	Currency of this bank account	string
Balance		decimal	200.38
BankAccount	Bank account addressing details	BankAccountDetails
MaturesOn		DateTime?	2025-01-12T00:00:00
DateOpened		DateTime?	2025-01-12T00:00:00
InterestPayableFrom	Interest payable from this date	DateTime?	2025-01-12T00:00:00
Duration		int?
DurationUnit	Unit of measurement for the duration	CmaDurationUnit?
InterestPayablePeriod		CmaInterestPayablePeriod?
InterestRate	Decimal representation of the interest rate, e.g. 5% should be 0.05	decimal?	200.38
ExpiryAction		CmaExpiryAction?
TaxFileNumber	ATO tax file number	string
Beneficiaries	Free form description of the beneficiaries	string
InitialInvestment	The initial amount invested	decimal	200.38
LastStatementSentOn	Keeps track of when the last statement was sent, used for regulatory compliance	DateTimeOffset?

CmaAccountState

Property	Description	Value
Open	Open	0
Closed	Closed	1

CmaAccountType

Property	Description	Value
ControlledMoney	Controlled Money	0
Investment	Investment	1

CmaDurationUnit

Property	Description	Value
Days	Days	0
Weeks	Weeks	2
Months	Months	2
Years	Years	3

CmaExpiryAction

Property	Description	Value
Terminate	Terminate	0
Reinvest	Reinvest	1

CmaInterestPayablePeriod

Property	Description	Value
OnMaturity	OnMaturity	0
Monthly	Monthly	1
Yearly	Yearly	2

---

CmaPaymentMethodDetail

Property	Description	Type	Example
Type		CmaPaymentMethodType
OwnerId		string
CmaTransactionId		string
PaymentMethodId		string?
PaymentMethodType		PaymentMethodType?
GeneralDetails		string?

CmaPaymentMethodType

Property	Description	Value
Receipt		0
Payment		1

---

CmaTransaction

Within the context of a CMA account, a transaction.

Property	Description	Type	Example
AccountId	The CMA account this transaction belongs to	string
Date	When was the transaction entered in to the system	DateTime	2025-01-12T00:00:00
OriginalDate	When did the transaction take place	DateTime	2025-01-12T00:00:00
RequestedOn	Applicable for payments only, the day it was requested	DateTimeOffset?
OtherJournalId	The journal id of the cash account money was transferred to/from	string
OtherAccountId	The cash account money was transferred to/from, mutually exclusive with OtherEntityId	string
OtherAccountName	The trust cash account’s name	string
OtherEntityId	The entity money was sent to, or received from, mutually exclusive with OtherAccountId	string
OtherEntityName	Other party’s sort name	string
ReceiptPaymentMethodDetail	Payment method details for RECEIPT	ReceiptPaymentMethodDetail?
PaymentPaymentMethodDetail	Payment method details for a PAYMENT	PaymentPaymentMethodDetail?
PaymentMethodDetail	Description of the payment method used for reporting	string
IsDebit	False means receipt, True means payment	bool	true, false
IsInterest	True means crediting interest, false means any other transactions	bool	true, false
Reason		string
Memo		string
Reference	Reference number issued by the firm	string
Amount	Amount in both base and foreign currency	decimal	200.38
AuthorisedBy	Authorised by employee id	string
State		CmaTransactionState
ReversesId	The Id of the transaction that this transaction reverses	string
IsReversed	Indicates if this is a reversed or a reversal transaction	Boolean
ReversalId	If this transaction has been reversed, the ReversalId	string

CmaTransactionState

Property	Description	Value
PaymentRequested	CMA payment requested	0
PaymentApproved	CMA payment approved	1
PaymentCancelled	CMA payment cancelled	2
Posted	Posted	3
Reversed	Reversed	4

---

ContactChannel

Property	Description	Value
Email		0
Post		1
SMS		2
Phone		3

---

CustomFieldDetails

Values for custom fields to be included in the migration.

Property	Description	Type	Example
Name	Name of the field to be imported	string
Type	Type of the field being imported	Type?
Value	Value of the imported field	string

---

Disbursement

Matter expenses.

Property	Description	Type	Example
Type		DisbursementType
Code	Code used to classify this disbursement internal to the firm (e.g. scan, print)	string
Date	The date the disbursement incurred, anticipated, or posting date in the case of cost recovery	DateTime	2025-01-12T00:00:00
Reference	Firm-issued reference number	string
SupplierReference	Supplier-issued reference number	string
Description		string
MatterId	The matter this disbursement belongs to	string
SupplierId	The supplier this disbursement is to be paid to. Only required for Anticipated and Incurred disbursements	string
PurchaseId	Applicable to ADs, if linked to a purchase, the purchase id	string
BillingAmount	Amount of the disbursement (ex tax), in matter currency	decimal?	200.38
BillingAmountBase	Amount of the disbursement (ex tax), in firm currency. Leave null if matter currency is same as firm currency	decimal?	200.38
BillingTaxCode	The tax code to use to bill to the client	string
BillingTax	Tax of the disbursement as charged to the client, in matter currency	decimal	200.38
BillingTaxBase	Tax of the disbursement as charged to the client, in firm currency. Leave null if matter currency is same as firm currency	decimal?	200.38
IsBilled	Whether this disbursement has been billed to the client yet	bool	true, false
Amount	Amount of the disbursement (ex tax), in supplier currency	decimal	200.38
AmountBase	Amount of the disbursement (ex tax), in firm currency. Leave null if supplier currency is same as firm currency	decimal?	200.38
TaxCode	Tax code as specified by the supplier	string
Tax	Tax of the disbursement as charged by the supplier, in supplier currency	decimal	200.38
TaxBase	Tax of the disbursement as charged by the supplier, in firm currency. Leave null if supplier currency is same as firm currency	decimal?	200.38
Currency	Currency the supplier deals in	string
ClientBalanceAmount	The remaining amount that the law firm has left to bill the client for	decimal	200.38
ClientBalanceTax	The remaining tax that the law firm has left to bill the client for	decimal	200.38
SupplierBalanceAmount	How much does the firm owe the supplier (ex tax) in supplier currency	decimal	200.38
SupplierBalanceTax	How much tax does the firm owe the supplier in supplier currency	decimal	200.38
SupplierBalanceAmountBase	How much does the firm owe the supplier (ex tax) in firm currency	decimal?	200.38
SupplierBalanceTaxBase	How much tax does the firm owe the supplier in firm currency	decimal?	200.38
UTBMSExpenseCode	LEDES disbursement code	string
IsBillable	Whether this disbursement will be billable or not — default true	bool	true, false

DisbursementType

Property	Description	Value
CostRecovery	Recovering office expenses	0
Anticipated	Anticipated disbursement, no invoice from supplier, no payment to supplier, but want to create it for billing	1
Incurred	Immediately paid out of the bank already	2

---

DisbursementCode

Allow a fee work item to be associated with task type for pre-filling and reporting.

Property	Description	Type	Example
Name	Display name of the disbursement code	string
Code	Code used by firm to identify this disbursement template	string
Description	As it will appear on invoices issued to the client	string
Type	Cost Recovery, Incurred, and Anticipated	DisbursementType
TaxCode	Supplier tax code	String?
Billable	Whether or not the disbursement is billable by default	bool	true, false
UTBMSExpenseCode	LEDES disbursement code if applicable	String?
Rate	Applicable for cost recovery only, in firm currency	decimal?	200.38
SupplierId	If specified, pre-fills the supplier when creating a disbursement	String?
Amount	Applicable only to incurred disbursements. Amount (ex tax) in supplier currency	decimal?	200.38
IncurredType	Type of Incurred Disbursement Code, not applicable to other types	IncurredType

---

Division

This represents a division.

Property	Description	Type	Example
Name		string
OfficeJournalId		string
TrustJournalId		string

---

EmailDeliveryOption

Property	Description	Value
ActingPerson	The acting person on the matter	0
ResponsiblePerson	The responsible person on the matter	1
Client	The client	2
BillingContact	The billing contact person on the matter	3
SpecificEmail	Manually specified email address	4

---

Employee

Property	Description	Type	Example
EntityId		string
TeamId	The team the employee belongs to. Teams are hierarchical — top level teams may map to practice groups	string
JobTitleId	Job title as assigned by the law firm	string
BillingGradeId	Billing grade categorises employees for the purposes of setting up billing rates	string
EmployeeNumber	Firm-issued identifier for this employee	string
NominalCostPerHour	Used for profitability analysis, in base currency	decimal	200.38
Notes		string
Email	Email address from the entity record	string
State		EmployeeState

EmployeeState

Property	Description	Value
Active	Has access to the system	0
Inactive	Does not have access to the system	1
Draft	In the process of creating	2

---

Entity

Property	Description	Type	Example
EmployeeId		string
SupplierId		string
ClientId		string
EntityType		EntityType
State		EntityState
IsVerified	(AML) Whether this entity has been verified	bool	true, false
VerifiedDate	(AML) Date when the entity was verified	DateTime?	2025-01-12T00:00:00
Currency	Currency this entity deals in. If not specified, the base currency is assumed	string?	GBP, AUD
Salutation	e.g. ‘To whom it may concern’, ‘Dear Mr Smith’	string
FirstName		string
MiddleNames		string
LastName		string
Initials		string
OrganisationName		string
OrganisationNumber	Company identifier, e.g. ABN	string
OrganisationNumber2	Secondary company identifier, e.g. ACN	string
OrganisationType	e.g. Joint Party, Company, Unlimited Liability Company	string
OrganisationContact	The point of contact of an organisation	string
PreferredName	Nickname which the person/company prefers to be identified by colloquially, e.g. Bob	string
Title		string
EntityNumber	Unique identifier for this entity issued by the firm	string
Email	Primary email of this entity	string
Addresses		IList<Address>
Numbers	Phone/Fax and other numbers	IList<Number>
BankAccount	Bank account	BankAccountDetails
CanLogin	Can this user log in when it is determined to be a user	bool?	true, false
RoleIds	If this entity is determined to be a user, the role it will have	IList<string>?
GroupMembers	If this entity is a group, then this lists the EntityIds of the members of this group	IList<string>?
CustomFields	Not Supported Yet A list of all the additional fields we do not support in standard migrations	IList<CustomFieldDetails>?
Associations		IList<Association>

EntityState

Property	Description	Value
Unverified	Identity not verified (e.g. AML)	0
Verified	Identity verified	1

EntityType

Property	Description	Value
Individual		0
Organisation		1
Group		2

---

GeneralDetail

Property	Description	Type	Example
Details		string

---

HistoricalTransaction

Represents a historical general ledger or ledger transaction.

Property	Description	Type	Example
Type	For office journals, specify Posting or Both to import journal entries and optionally ledger entries. For trust journals, this must be Ledger.	HistoricalTransactionType
TransactionType		TransactionType
JournalId		string
JournalType	Specify the type of journal this transaction will be written into	JournalType
AccountId	Required when Type is ‘Ledger’, specifies the Historical Balancing account to post the ledger entry against	string
Reference	Identifier used by the user to uniquely identify this transaction, e.g. journal reference	string
OtherPartyId	Entity id of the other party if there is an associated entity	string
OtherPartyName		string
OtherPartyAddress	Together with name, uniquely identifies the other party	string
Reason		string
Date	Posting Date of the transaction	DateTime	2025-01-12T00:00:00
OriginalDate		DateTime	2025-01-12T00:00:00
EnteredOn	Captures the date that the transaction was recorded into the database	DateTimeOffset?
Amount	When Type is Ledger, receipts are positive. Otherwise, it is the sum of Splits with positive amount (i.e. debits)	decimal	200.38
PaymentPaymentMethod	When this transaction is a Payment, the payment details	PaymentPaymentMethodDetail?
ReceiptPaymentMethod	When this transaction is a Receipt, the receipt details	ReceiptPaymentMethodDetail?
Memo		string?
IsReconciled	Indicate if it has been reconciled. Applicable to cashbook entry only.	bool	true, false
ClearanceDate	Optionally specify when this receipt will be cleared. Applicable to cashbook entry only.	DateTime?	2025-01-12T00:00:00
Splits		IList<HistoricalTransactionSplit>

HistoricalTransactionSplit

This is part of a HistoricalTransaction.

Property	Description	Type	Example
AccountId	Specify only if item is related to a GL code, and not a matter or supplier	string?
MatterId	Specify only if item is related to a matter, mutually exclusive with AccountId and SupplierId	string?
SupplierId	Specify only if item is related to a supplier	string?
InvoiceId	Specify only if item is related to a client invoice, and must be supplied with MatterId	string?
LedgerType	If specified, this is a ledger entry	LedgerType?
Memo		string
Amount	Debit positive	decimal	200.38
Tax		decimal	200.38
TaxCode		string
TaxType	Specifies the tax is input or output tax	TaxAppliesTo

HistoricalTransactionType

Property	Description	Value
Posting	General ledger posting with journal entries only	0
Ledger	Ledger entries only on matter trust or office, or supplier	1
Both	General ledger posting with associated ledger entries	2

---

IncurredType

Property	Description	Value
Purchase	Received an invoice from the supplier	0
Payment	Will be paid out of the bank immediately when created	1

---

Invoice

Only outstanding invoices are supported.

Property	Description	Type	Example
MatterId		string
MatterNumber		string
MatterTitle		string
ClientEntityId		string
ActingPersonId		string
ResponsiblePersonId		string
ClientId		string
InvoiceNumber		string
InvoiceDate		DateTime	2025-01-12T00:00:00
DueDate		DateTime	2025-01-12T00:00:00
SentDate	The date the invoice was sent to the customer	DateTime?	2025-01-12T00:00:00
Currency	Invoice currency as shown to the recipient. If not specified, assumes base currency. Must be the same as matter currency	string
ExchangeRate	Exchange rate used to take base currency to transaction currency	decimal	200.38
ApprovedForReceipt	Allow a trust-to-office transfer to take place automatically	bool	true, false
TemplateId	The invoice template applied, or null if using default	string
BillToEntityId	The entity the invoice is addressed to	string
AttentionOf	Who to attention the invoice to	string
BillingAddress	Address of the entity to bill	string
Title	Description of the invoice, e.g. Fees and Disbursements for January	string
Comments	Internal notes on the invoice	string
RetainedAmount	When queried, all non-released allotments against this invoice are summed	decimal?	200.38
TotalAmount	The total amount in matter currency (excluding tax)	decimal	200.38
TotalTax	The total tax in matter currency	decimal	200.38
TotalAmountBase	The total amount in base currency if different (excluding tax)	decimal?	200.38
TotalTaxBase	The total tax in base currency if different	decimal?	200.38
Balance	How much left for client to pay (inclusive of tax)	decimal	200.38
BalanceBase	How much left for client to pay in base currency if different (inclusive of tax)	decimal	200.38
Items		IList<InvoiceItem>
Allocations	Not Supported Yet	IList<InvoiceAllocation>

InvoiceAllocation

Not currently supported.

Property	Description	Type	Example
Date	Date the receipt was allocated or write off was dated	DateTime	2025-01-12T00:00:00
TransactionId	The transaction id that caused this allocation	string
Type		InvoiceAllocationType
ItemType		InvoiceItemType
AccountId		string
Amount	The amount allocated, exclusive of tax	decimal	200.38
Tax	The tax allocated	decimal	200.38
TaxCode	Need to populate this for cash-basis accounting	string

InvoiceAllocationType

Property	Description	Value
Collection	Regular receipt	0
WriteOff	Write-off, loss caused by client	1
ClientPayment	When client makes a direct payment to third party, reducing invoice balance	2
CreditNote	Loss caused by the firm	3

InvoiceItem

Property	Description	Type	Example
InvoiceId		string
ParentInvoiceItemId		string
Type		InvoiceItemType
DisbursementId	(Only use if this item is a billed, unpaid anticipated disbursement) Supplier who billed this item	string
Date	The date when the invoice item was originally actioned	DateTime	2025-01-12T00:00:00
Title	One-liner describing what the line item is	string
Description	Lengthy description of what the line item is	string
BillerId	Employee who billed this line item	string
Units	Number of units	decimal	200.38
UnitPrice	Unit price of each unit, in invoice currency	decimal	200.38
OriginalAmountSplit	The original amount after this invoice was split	decimal	200.38
BillingUnits	Overridden billing units for the line item, for display purposes	decimal?	200.38
BillingUnitPrice	Overridden billing units price for the line item, for display purposes, in invoice currency	decimal?	200.38
BillingAmount	Overridden line total in invoice currency	decimal?	200.38
Amount	Line total in invoice currency, unrounded, exclusive of tax. It must be equal to Units * UnitPrice	decimal	200.38
Tax	Tax in invoice currency, unrounded	decimal	200.38
TaxCode	The tax code applicable to this item	string
SortOrder	The order in which the invoice items should appear in the invoice report	int?

InvoiceItemType

Property	Description	Value
GroupHeader	Group header that includes other child items	0
Fees	Post to fees. If negative, it’s a discount	1
CostRecovery	Post to cost recovery	2
Disbursement	Post to disbursement	3
AnticipatedDisbursement	Post to anticipated disbursement	4
Account	Post to the specified account	5
Discount	Discount applied to the invoice	6

---

JobTitle

Property	Description	Type	Example
Name		string

---

Journal

This represents a journal.

Property	Description	Type	Example
Name		string
Type		JournalType
IsDefault		bool	true, false
Accounts		IList<Account>

JournalType

Property	Description	Value
Office	Office journal
Trust	Trust (Client) journal
Other	Other Journal, such as Controlled Money or Client Deposit if separate

---

LedgerBalance

Opening balances for a Matter or Supplier.

Property	Description	Type	Example
Type		LedgerOwnerType
OwnerId	The Matter or Supplier ImportId that this balance belongs to	string
AccountID	The Account Id that this balance belongs to	string
Balance		decimal	200.38

LedgerOwnerType

Property	Description	Value
MatterOffice	Matter Office Balance	0
MatterTrust	Matter Trust/Client Balance	1
Supplier	Supplier Balance	2

LedgerType

Property	Description	Value
Office		0
Trust		1
Supplier		2
Other		3

---

Matter

Property	Description	Type	Example
State		MatterState
AclId	ACL Identifier to control the access permissions to this matter	string
DivisionId		string
ClientId		string
OfficeLedgerId	The one and only office ledger	string
ResponsiblePersonId		string
ActingPersonId		string
AssistingPersonId		string
IntroducerId	The employee who introduced this matter to the firm	string
ReferrerId	Details about the external source that referred this client to the firm	ReferrerDetails?
MatterTypeId	Matter type	string
MatterNumber	User facing unique identifier for the matter	string
Title	One-line description of the matter	string
SortTitle	Shorter title used for display and sorting	string
DateOpened	The date on which the matter was opened	DateTime?	2025-01-12T00:00:00
DateClosed	The date on which the matter was closed	DateTime?	2025-01-12T00:00:00
BillingContactId		string
InvoiceEmailCC	A comma separated list of emails to also send any invoices to	string
ExchangeRate	If the matter currency is different from the firm’s base currency, the exchange rate to convert firm currency to matter currency	decimal?	200.38
RateSetId	Specifies which set of rates to look up when entering work items	string
OverrideRateSetId	Overrides which set of rates to look up when entering work items	string
BillingBasis	Method by which billing is done on this matter	BillingBasis?
MarkedForBilling	Flag to indicate this matter is ready for billing	bool	true, false
ProtectedTrustAmount	Reserved Amount in Trust Account for special purposes	decimal	200.38
AutoGenerateStatements	Whether to generate statements for the matter and send them to the client automatically	bool	true, false
FeeEstimate	Estimated fee target for the matter	decimal?	200.38
DisbursementEstimate	Estimated disbursement target for the matter	decimal?	200.38
LastTrustStatementIssued	When the last trust statement of the matter issued	DateTimeOffset?
LastCmaStatementIssued	When the last controlled money statement of the matter issued	DateTimeOffset?
LastInvStatementIssued	When the last investment statement of the matter issued	DateTimeOffset?
CreditNoteBalance	Value of non-cash credit note balance on the matter	decimal	200.38
OfficeFundsBalance	Value of cash credit funds balance on the matter’s office ledger	decimal	200.38
TrustFundsBalance	Value of trust funds balance on the matter, by each bank account	Map
Parties	A list of entities related to the matter and their relationship/role	IList<Party>
ClientRole	The role that the client plays in the matter (e.g. Defendant, Plaintiff, Agency)	string
DateArchived		DateTime?	2025-01-12T00:00:00
DateDestroyed		DateTime?	2025-01-12T00:00:00
StorageLocation		string
ArchiveNumber		string
BoxNumber		string
ArchivedById		string
DestroyedById		string
CustomFields	A list of all the additional fields we do not support in standard migrations	IList<CustomFieldDetails>?

MatterState

Property	Description	Value
Draft	In the process of being opened, i.e. running through a todo list	0
Active	Active	1
OnHold	On Hold, no work to be done on it	2
Closing		3
Closed		4

---

MatterType

Matter types.

Property	Description	Type	Example
Name		string
Description		string

---

Number

Property	Description	Type	Example
Type		NumberType
Name	Optional name to identify this number, e.g. Spouse Work	string
Notes	Optional additional information on how this contact should be used	string
Value	The number itself	string
Default		bool	true, false

NumberType

Property	Description	Value
Home	Home	0
Mobile	Mobile	1
Work	Work	2
Email	Email	3
Fax	Fax	4
Other	Other	5

---

Party

The role that entities play on a matter (e.g. Solicitor, Guarantor, Director).

Property	Description	Type	Example
Role	The name of the role (e.g. Solicitor, Guarantor, Director)	string
Reference	Reference to use for correspondence with this party	string
Subject	Description of the matter	string
Memo	Internal notes about the entity	string
EntityId	The entity playing this role in the matter	string
Type	How this entity is associated with the matter (e.g. Representative, Party)	PartyType

PartyType

Property	Description	Value
Representative		0
Party		1

---

PaymentChequeDetail

Property	Description	Type	Example
PaidTo		string
Number		string
IssueDate		DateTime?	2025-01-12T00:00:00
Branch		string
Institution		string

---

PaymentCreditCardDetail

Property	Description	Type	Example
CardHolder		string
Type		string
Name		string

---

PaymentEFTDetail

Property	Description	Type	Example
BankAccount		BankAccountDetails
Reference		string
SequenceNumber		string
BankReference		string
IncludeInABA		bool	true, false

---

PaymentMethodType

Property	Description	Value
General		0
Cheque		1
EFT		2
CreditCard	Credit Card	3
Cash		4

---

PaymentPaymentMethodDetail

Property	Description	Type	Example
PaymentMethodId		string
General		GeneralDetail
Cheque		PaymentChequeDetail
Cash		CashDetail
EFT		PaymentEFTDetail
CreditCard		PaymentCreditCardDetail
Type		PaymentMethodType

---

Purchase

Represents unpaid purchase orders and supplier invoices.

Property	Description	Type	Example
JournalId		string
PurchaseNumber	The identifying number issued by the firm	string
InvoiceNumber	Supplier’s invoice number for this purchase	string
PaymentReference	Supplier-issued payment reference number to include in a payment	string
Date	Date to use for posting to Journals and Ledgers	DateTime?	2025-01-12T00:00:00
DueDate	Date the purchase is due	DateTime?	2025-01-12T00:00:00
OriginalDate	As shown on supplier invoice	DateTime?	2025-01-12T00:00:00
SupplierId	The supplier this purchase is made from	string
Currency	Purchase currency as received from the supplier	string
ExchangeRate	Exchange rate used to take base currency to transaction currency	decimal	200.38
SupplierComments	Comments sent to the supplier when the purchase is approved	string
TotalAmount	The total amount in supplier currency (exclusive of tax)	decimal	200.38
TotalTax	The total tax in supplier currency	decimal	200.38
Balance	How much left to pay the supplier (inclusive of tax)	decimal	200.38
TotalAmountBase	The total amount in base currency if different (exclusive of tax)	decimal?	200.38
TotalTaxBase	The total tax in base currency if different	decimal?	200.38
BalanceBase	How much left to pay the supplier (inclusive of tax) in base currency if different	decimal?	200.38
Description	Additional details about the supplier invoice	string
Items		IList<PurchaseItem>

PurchaseItem

Every purchase, creditor or payment alike, has one or more item specifying how it is classified/allocated.

Property	Description	Type	Example
PurchaseId		string
Type	What type of line item this is	PurchaseItemType
DisbursementId	Applicable only if PurchaseItemType is Anticipated Disbursement	string
AccountId	The general ledger account this line item posts to, required only for PurchaseItemType of Account	string
Reference	A user-friendly unique identifier for this line item	string
Title	One-liner describing what the line item is	string
Description	Lengthy description of what the line item is	string
Amount	Amount in supplier currency, exclusive of tax	decimal	200.38
Tax	Tax in supplier currency	decimal	200.38
AmountBase	Amount in firm currency, exclusive of tax. Only required if supplier currency is different from firm currency	decimal?	200.38
TaxBase	Tax in firm currency. Only required if supplier currency is different from firm currency	decimal	200.38
TaxCode	The supply tax code applicable to this item	string

PurchaseItemType

Property	Description	Value
Account	If it is related to a general ledger account code only, and not a disbursement	0
Disbursement	If it is related to a disbursement; ensure MatterId is specified	1
AnticipatedDisbursement	If it is related to an anticipated disbursement; ensure DisbursementId is specified	2

---

ReceiptChequeDetail

Property	Description	Type	Example
Number		string
Drawer		string
Branch		string
Institution		string
IssuedOnDate		DateTime?	2025-01-12T00:00:00
ClearsOnDate		DateTime?	2025-01-12T00:00:00
Memo		string

---

ReceiptCreditCardDetail

Property	Description	Type	Example
CardHolderName		string
Type		string

---

ReceiptEFTDetail

Property	Description	Type	Example
Reference		string

---

ReceiptPaymentMethodDetail

Property	Description	Type	Example
PaymentMethodId		string
General		GeneralDetail
Cheque		ReceiptChequeDetail
Cash		CashDetail
EFT		ReceiptEFTDetail
CreditCard		ReceiptCreditCardDetail
Type		PaymentMethodType

---

ReferrerDetails

Details about the external referrer.

Property	Description	Type	Example
Name	The name of the referrer for reporting purposes. If EntityId is specified, then the entity’s sort name will be used instead.	string?
EntityId	Optional if ReferrerName is specified.	string?
Source	Optional description of the referrer source, such as Walk-in, Google, Facebook, Directory/Contact.	string?

---

Supplier

Property	Description	Type	Example
EntityId		string
State		SupplierState
SupplierNumber		string
BillingContactId	Billing contact for purchase orders and billing enquiries to be sent to	string
DefaultPaymentTerm	Number of days from supplier invoice date the supplier invoice will fall due by default	int?
RecogniseTaxOnPayment	Specifies that purchases to this supplier posts to AccountRole.TaxSuspense rather than AccountRole.TaxPaid	bool	true, false
TaxCode	The tax code applicable to this supplier	string
DebitNotesBalances	Not Supported Yet Amount of supplier non-cash credits available, in supplier currency by journal	Dictionary<string, decimal>
DebitFundsBalances	Not Supported Yet Amount of supplier pre-payment available, in supplier currency by journal	Dictionary<string, decimal>
Notes		string

SupplierState

Property	Description	Value
Draft	In the process of creating	0
Active	Normal Supplier	1
Held	No work can be done with this supplier	2
Closing	In the process of being closed	3
Closed	No longer transacting with	4

---

TaskType

Property	Description	Type	Example
Name	Descriptive title to help user choose the correct task type to use	string
Code	Short identifier of this task type used only in reports	string
Itemised	When true, and chosen for a work item, pre-select it as an itemised fee	bool	true, false
Billable	When true, and chosen for a work item, pre-selects the work item as non-billable	bool	true, false
Narration	Pre-populate the narration on work item	string
Description	Detailed explanation of this task type, what it is, when it should be used	string
Shortcut	Key sequence to trigger text expansion to select this task type	string
UTBMSTaskCode		string
UTBMSActivityCode		string

---

TaxAppliesTo

Property	Description	Value
None	Tax is not applicable	0
Sales	Sales (will go to Tax Collected account)	1
Purchases	Purchase (will go to Tax Paid account)	2

---

Team

Property	Description	Type	Example
Name		string

---

TransactionType

Property	Description	Value
General	General ledger transaction posting	0
Receipt	Receipt	1
Payment	Payment	2

---

WorkItem

Property	Description	Type	Example
Title	Title as it will appear by default on invoice	string
ItemType	Timed, Itemised, or Leave	WorkItemType
FileNote	File note taken against this work item	string
TaskTypeId	Type of work reference	string
EmployeeId	Employee who did the work, aka Fee Earner	string
EmployeeTeamId	Team to attribute this time entry to, defaults to fee-earner’s team at the time of entry	string
MatterId	The matter the work is for, can be null if work item is in draft	string
BillingStageId	If this work item is related to a billing stage	string
InvoiceId	If this work item is included on an invoice, the invoice id	string
EntryDate	When was the work done	DateTimeOffset
DurationTicks	Duration of work done in ticks (100 nanoseconds), only applicable for Timed work items	long?
Units	Number of units. For timed work items (if not specified), this is derived from DurationTicks and the minutes per unit setting. For itemised work items, this is specified directly.	decimal?	200.38
Rate	Rate per unit (Itemised) or hours (Timed) in client currency. This is exclusive of tax.	decimal?	200.38
Total	FxAmount to provide a base currency for standardised management reporting	decimal?	200.38
TaxCode	The tax code applicable to this item	string
Tax	Tax amount based on the Total if specified, or Units * Rate	decimal?	200.38
State		WorkItemState
WorkItemParts	[Internal] Breakdown of this work item into multiple parts	List<WorkItemPart>?

WorkItemPart

Property	Description	Type	Example
Units		decimal?	200.38
DurationTicks		long?
Narration		string
SumToParent		bool	true, false

WorkItemState

Property	Description	Value
Pending	Incomplete	0
Finalised	Ready for billing	1
Drafted	Included on a draft or pending invoice	2
Billed	Made its way to a finalised invoice	3
WrittenOff	Professional service in nature, but the firm absorbs the cost	4
NonBillable	Administrative or non-professional service in nature, such as internal training	5

WorkItemType

Property	Description	Value
TimedFee	Timed Fee	0
ItemisedFee	Itemised Fee	1
Leave	Leave	2