Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Fees

Get a fee

Retrieves a specified fee.

get/matters/{matterId}/fees/{id}

Path parameters

idstring required
matterIdstring required

Response

When request is successful. Returns a 'Fee' object.

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the fee.

versionIdstring nullable

Unique version identifier of the fee.

matterIdstring nullable

Deprecated, use Matter.

staffIdstring nullable

Deprecated, use Staff.

createdByUserIdstring nullable

Unique identifier of the user that created the fee.

createdDatestring date-time

Date the fee was created.

lastUpdatedByUserIdstring nullable

Unique identifier of the user that updated the fee.

invoiceIdstring nullable

Unique identifier of the associated invoice.

activityCodestring nullable

The activity code associated to the fee.

utbmsTaskCodestring nullable

The UTBMS task code associated to the fee, where UTBMS is enabled. Only applicable in US.

subjectstring nullable

The subject - this should be a short description of the fee.

descriptionstring nullable

Optional detailed description of the fee.

feeDatestring date-time

The date of the fee.

feeType0 | 1

The type of the fee (Fixed = 0, Time = 1).

finalizedboolean

True if the fee has been finalized.

isInvoicedExternallyboolean

True if the fee is invoiced externally.

isWrittenOffboolean

True if the fee is written off. True only allowed if IsBillable is true.

Written off fee will show on an invoice with their amount, but will not be counted in the invoice total.

isBillableboolean nullable

True if the fee is billable. Non-billable fee will, by default, not be shown on invoices (and, if shown, the amount will be 0).

taxnumber double

GST amount of the fee in dollars. Only applicable in AU.

taxInclusiveboolean

If true, the amount is GST inclusive, otherwise GST exclusive. Only applicable in AU.

GST inclusive means: Amount exc. GST = Amount - GST, Amount inc. GST = Amount.

GST exclusive means: Amount exc. GST = Amount, Amount inc. GST = Amount + GST.

taxExemptboolean

True if the fee is tax exempt. In that case, Tax will always be 0.

taxOutOfScopeboolean

True if the fee is out of scope for tax. In that case, Tax will always be 0.

durationinteger

The duration billed - in minutes.

durationWorkedinteger nullable

The duration worked - in minutes.

ratenumber double

The rate of the fee in dollars.

amountnumber double

Total amount of the fee in dollars. Calculated using Rate and Duration depending on the fee type.

This amount includes tax depending on the TaxInclusive property. See AmountExcTax and AmountIncTax.

amountExcTaxnumber double

Amount excluding tax in dollars. Calculated from Amount and Tax depending on the TaxInclusive property.

If tax is not applicable (outside AU), this will be the same as Amount.

amountIncTaxnumber double

Amount including tax in dollars. Calculated from Amount and Tax depending on the TaxInclusive property.

If tax is not applicable (outside AU), this will be the same as Amount.

billableAmountExcTaxnumber double

Billable amount excluding tax in dollars. If fee is billable, value will be the same as AmountExcTax. If it's non-billable, value will be 0.

If the fee is partially billable (i.e. has source items, some of which are billable and some not), this value will contain the amount calculated from billable items only.

billableTaxnumber double

Billable tax in dollars. If fee is billable, value will be the same as Tax. If it's non-billable, value will be 0.

If the fee is partially billable (i.e. has source items, some of which are billable and some not), this value will contain the tax calculated from billable items only. In all other cases, the value will be the same as Tax.

isDeletedboolean

True if the fee is deleted.

createdFromActivityIdstring nullable

Unique identifier of the Activity used to create the fee, if applicable.

Example response

{
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "createdByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "createdDate": "2026-04-13T11:00:00Z",
  "lastUpdatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "invoiceId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "activityCode": "PRT",
  "utbmsTaskCode": "L110",
  "subject": "Review contract",
  "description": "Print documents",
  "feeDate": "2022-07-01",
  "tax": 35,
  "duration": 60,
  "durationWorked": 50,
  "rate": 350,
  "amount": 350,
  "amountExcTax": 315,
  "amountIncTax": 350,
  "billableAmountExcTax": 315,
  "billableTax": 35,
  "createdFromActivityId": "504b9f77-20c7-4dee-8227-d3007c8f6cea"
}