SMsmokeball
Matters

Get matter billing configuration

Retrieves the billing configuration for the specified matter.

get/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

Response

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

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
versionIdstring nullable

Version id of the billing configuration.

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' or 'Time Based'.

disbursementAmountnumber double

The disbursement amount (currency).

Only applicable when BillingType is 'Fixed Fee', 'Fixed Fee per Apperance' or 'Time Based'.

Only supported in AU and the UK.

contingencyAmountnumber double

The contingency amount (percentage).

Only applicable when BillingType is 'Contingency Percent'.

rateSetIdstring nullable

The rate set id.

Only supported in AU and the UK.

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.

Example response

{
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "amount": 142.31,
  "disbursementAmount": 160,
  "contingencyAmount": 32,
  "rateSetId": "100558",
  "isUtbmsEnabled": true,
  "ledesFirmId": "100558",
  "ledesMatterId": "100558",
  "ledesClientMatterId": "100558"
}

Changes

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