GET
/
matters
/
{matterId}
/
fees
/
{id}
Get a fee
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/fees/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "staff": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "matterId": "<string>",
  "staffId": "<string>",
  "createdByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "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",
  "feeType": 0,
  "finalized": false,
  "isInvoicedExternally": false,
  "isWrittenOff": false,
  "isBillable": false,
  "tax": 35,
  "taxInclusive": false,
  "duration": 60,
  "durationWorked": 50,
  "rate": 350,
  "amount": 350,
  "amountExcTax": 315,
  "amountIncTax": 350,
  "billableAmountExcTax": 315,
  "billableTax": 35,
  "isDeleted": false,
  "sourceItems": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "description": "<string>",
      "duration": 123,
      "isBillable": true
    }
  ],
  "createdFromActivityId": "504b9f77-20c7-4dee-8227-d3007c8f6cea"
}

Authorizations

​
x-api-key
string
header
required
​
Authorization
string
header
required

Path Parameters

​
id
string
required
​
matterId
string
required

Response

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

​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the fee.

Example:

"b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"

​
versionId
string | null

Unique version identifier of the fee.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
matter
object

The matter associated to the fee.

​
staff
object

The staff member associated to the fee.

​
matterId
string | null

Deprecated, use Matter.

​
staffId
string | null

Deprecated, use Staff.

​
createdByUserId
string | null

Unique identifier of the user that created the fee.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
lastUpdatedByUserId
string | null

Unique identifier of the user that updated the fee.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
invoiceId
string | null

Unique identifier of the associated invoice.

Example:

"750eb5c5-ac0b-7d11-4997-e0ce9d8896c8"

​
activityCode
string | null

The activity code associated to the fee.

Example:

"PRT"

​
utbmsTaskCode
string | null

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

Example:

"L110"

​
subject
string | null

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

Example:

"Review contract"

​
description
string | null

Optional detailed description of the fee.

Example:

"Print documents"

​
feeDate
string<date-time>

The date of the fee.

Example:

"2022-07-01"

​
feeType
enum<integer>

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

Available options:
0,
1
Example:

0

​
finalized
boolean

True if the fee has been finalized.

Example:

false

​
isInvoicedExternally
boolean

True if the fee is invoiced externally.

Example:

false

​
isWrittenOff
boolean

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.

Example:

false

​
isBillable
boolean | null

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).

Example:

false

​
tax
number

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

Example:

35

​
taxInclusive
boolean

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.

Example:

false

​
duration
integer

The duration billed - in minutes.

Example:

60

​
durationWorked
integer | null

The duration worked - in minutes.

Example:

50

​
rate
number

The rate of the fee in dollars.

Example:

350

​
amount
number

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.

Example:

350

​
amountExcTax
number

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.

Example:

315

​
amountIncTax
number

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.

Example:

350

​
billableAmountExcTax
number

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.

Example:

315

​
billableTax
number

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.

Example:

35

​
isDeleted
boolean

True if the fee is deleted.

Example:

false

​
sourceItems
object[] | null

The source items on the fee.

​
createdFromActivityId
string | null

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

Example:

"504b9f77-20c7-4dee-8227-d3007c8f6cea"