Get matter billing configuration

Retrieves the billing configuration for the specified matter.

GET /matters/{matterId}/billingconfiguration

Get matter billing configuration

cURL

curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/billingconfiguration \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.smokeball.com/matters/{matterId}/billingconfiguration"

headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', Authorization: '<api-key>'}};

fetch('https://api.smokeball.com/matters/{matterId}/billingconfiguration', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.smokeball.com/matters/{matterId}/billingconfiguration",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smokeball.com/matters/{matterId}/billingconfiguration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.smokeball.com/matters/{matterId}/billingconfiguration")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.smokeball.com/matters/{matterId}/billingconfiguration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "versionId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "billingType": 1,
  "amount": 142.31,
  "disbursementAmount": 160,
  "contingencyAmount": 32,
  "debtors": [
    {
      "id": "<string>",
      "href": "<string>",
      "relation": "<string>",
      "method": "GET"
    }
  ],
  "rateSetId": "100558",
  "isUtbmsEnabled": true,
  "ledesFirmId": "100558",
  "ledesMatterId": "100558",
  "ledesClientMatterId": "100558",
  "ledesTimekeeperClassificationType": 0
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-api-key · string · header · required

Authorization · string · header · required

Path Parameters

matterId · string · required

Response

200

application/json

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

id · string | null

href · string | null

relation · string | null

method · string | null · default: GET

self · object | null

Show child attributes

versionId · string | null

Version id of the billing configuration.

Example:

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

billingType · enum<integer>

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

Available options: 0, 1, 2, 3, 4, 5, 6, 7

Example:

1

amount · number<double>

The amount (currency).

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

Example:

142.31

disbursementAmount · number<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.

Example:

160

contingencyAmount · number<double>

The contingency amount (percentage).

Only applicable when BillingType is 'Contingency Percent'.

Example:

32

debtors · object[] | null

The matter debtors.

Show child attributes

rateSetId · string | null

The rate set id.

Only supported in AU and the UK.

Example:

"100558"

isUtbmsEnabled · boolean

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

Only supported in the US.

Example:

true

ledesFirmId · string | null

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

Only supported in the US.

Example:

"100558"

ledesMatterId · string | null

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

Only supported in the US.

Example:

"100558"

ledesClientMatterId · string | null

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

Only supported in the US.

Example:

"100558"

ledesTimekeeperClassificationType · enum<integer>

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

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

Only supported in the US.

Available options: 0, 1, 2

Example:

0