v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Fees

Create a fee

Creates a fee for the specified matter.

post/matters/{matterId}/fees

Path parameters

matterIdstring required

Request body

updatedByUserIdstring nullable

Unique identifier of the user updating the fee.

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

staffIdstring nullable

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.

invoiceIdstring nullable

Unique identifier of the associated invoice.

activityCodestring nullable

The activity code associated to the fee.

feeType0 | 1

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

feeDatestring date-time required

The date of the fee.

subjectstring required

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

descriptionstring nullable

Optional detailed description of the fee.

durationinteger

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

durationWorkedinteger nullable

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

ratenumber double

The rate of the fee in dollars.

taxnumber double nullable

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.

taxInclusiveboolean

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)

taxExemptboolean

True if the fee is exempt from tax.

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

taxOutOfScopeboolean

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.

finalizedboolean

True if the fee has been finalized.

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

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

isInvoicedExternallyboolean

True if the fee is invoiced externally.

createdFromActivityIdstring nullable

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

Example request

{
  "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "invoiceId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "activityCode": "PRT",
  "feeDate": "2022-07-01",
  "subject": "Review contract",
  "description": "Print documents",
  "duration": 60,
  "durationWorked": 50,
  "rate": 350,
  "tax": 35,
  "sourceItems": [
    {
      "description": "Print document",
      "duration": 5
    }
  ],
  "createdFromActivityId": "504b9f77-20c7-4dee-8227-d3007c8f6cea"
}

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable