PATCH
/
matters
/
{matterId}
/
fees
/
{id}
Patch a fee
curl --request PATCH \
  --url https://api.smokeball.com/matters/{matterId}/fees/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "invoiceId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "activityCode": "PRT",
  "feeType": 0,
  "feeDate": "2022-07-01",
  "subject": "Review contract",
  "description": "Print documents",
  "duration": 60,
  "durationWorked": 50,
  "rate": 350,
  "tax": 35,
  "taxInclusive": false,
  "taxExempt": false,
  "taxOutOfScope": false,
  "finalized": false,
  "isWrittenOff": false,
  "isBillable": false,
  "isInvoicedExternally": false,
  "sourceItems": [
    {
      "description": "Print document",
      "duration": 5,
      "isBillable": false
    }
  ],
  "createdFromActivityId": "504b9f77-20c7-4dee-8227-d3007c8f6cea"
}'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}

Authorizations

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

Path Parameters

​
matterId
string
required
​
id
string
required

Body

​
feeDate
string<date-time>
required

The date of the fee.

Example:

"2022-07-01"

​
subject
string
required

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

Minimum length: 1
Example:

"Review contract"

​
updatedByUserId
string | null

Unique identifier of the user updating the fee.

This field is reserved for server-to-server operations.

Example:

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

​
staffId
string | null

Unique identifier of the associated staff member.

When StaffId is not provided, the API will attempt to match your User Id to a Staff Id automatically.

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"

​
feeType
enum<integer>

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

Available options:
0,
1
Example:

0

​
description
string | null

Optional detailed description of the fee.

Example:

"Print documents"

​
duration
integer

The duration billed - in minutes. This duration is used if there are no sub activities.

Example:

60

​
durationWorked
integer | null

The duration worked - in minutes. This duration is used if there are no sub activities.

Example:

50

​
rate
number

The rate of the fee in dollars.

Example:

350

​
tax
number | null

Tax amount of the fee in dollars. Only applicable in AU and UK regions.

When TaxOutOfScope or TaxExempt is true, this value must be 0.

Example:

35

​
taxInclusive
boolean

If true, the amount is tax inclusive, otherwise tax exclusive. Only applicable in AU and UK regions.

Tax inclusive means: Amount exc. tax = Amount - Tax, Amount inc. tax = Amount.

Tax exclusive means: Amount exc. tax = Amount, Amount inc. tax = Amount + Tax.

(Amount = Rate for fixed fees, or Rate * Duration for time fees, Tax = value of the Tax field)

Example:

false

​
taxExempt
boolean

True if the fee is exempt from tax.

This field is mutually exclusive with TaxOutOfScope. When true, Tax must be 0.

Example:

false

​
taxOutOfScope
boolean

True if the fee is out of scope for tax purposes. Only supported in UK regions.

This field is mutually exclusive with TaxExempt. When true, Tax must be 0.

Example:

false

​
finalized
boolean

True if the fee has been finalized.

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

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

​
isInvoicedExternally
boolean

True if the fee is invoiced externally.

Example:

false

​
sourceItems
object[] | null

The source items on the fee.

​
createdFromActivityId
string | null

Associates an existing activity id to a fee. Only valid for Fee creation. Value is supplied by Smokeball for some partners.

Example:

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

Response

When request is accepted. Returns a hypermedia 'Link' object of the fee to be patched.

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