SMsmokeball
Matters

Patch matter billing configuration

Patches the billing configuration for the specified matter.

patch/matters/{matterId}/billingconfiguration

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/matters/{matterId}/billingconfiguration
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

matterIdstring required

Request body

billingType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7

The billing type.

Possible values: None = 0, Fixed Fee = 1, Fixed Fee per Appearance = 2, Time Based = 3, Contingency Dollars = 4, Contingency Percent = 5, Not Billable = 6, ConditionalFeeAgreement = 7

amountnumber double

The amount (currency).

Only applicable when BillingType is 'Fixed Fee', 'Fixed Fee per Apperance', 'Contingency ($)' or 'Time Based'.

contingencyAmountnumber double

The contingency amount (percentage).

Only applicable when BillingType is 'Contingency Percent'.

disbursementAmountnumber double

The disbursement amount (currency).

Only applicable when BillingType is 'Fixed Fee', 'Fixed Fee per Apperance', 'Contingency ($)' or 'Time Based'.

Only supported in the UK.

debtorIdsstring[] nullable

The matter debtors. Must be valid contact id(s) and a maximum of 3 debtors can be set.

isUtbmsEnabledboolean

True if Uniform Task Based Management (UTBMS) is enabled for this matter.

Only supported in the US.

ledesFirmIdstring nullable

The associated Legal Electronic Data Exchange Standard (LEDES) firm.

Only supported in the US.

ledesMatterIdstring nullable

The associated Legal Electronic Data Exchange Standard (LEDES) matter.

Only supported in the US.

ledesClientMatterIdstring nullable

The associated Legal Electronic Data Exchange Standard (LEDES) client matter.

Only supported in the US.

ledesTimekeeperClassificationType0 | 1 | 2

The associated Legal Electronic Data Exchange Standard (LEDES) classification type.

Possible values: Length6 = 0, Length2 = 1, UseFirmDefault = 2.

Only supported in the US.

rateSetIdstring nullable

The RateSet Id.

Only supported in the UK.

Example request

{
  "amount": 142.31,
  "contingencyAmount": 32,
  "disbursementAmount": 520.67,
  "isUtbmsEnabled": true,
  "ledesFirmId": "100558",
  "ledesMatterId": "100558",
  "ledesClientMatterId": "100558",
  "rateSetId": "100558"
}

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

No recorded changes to this operation across all 15 revisions of this API.