Skip to main content
PATCH
/
matters
/
{matterId}
/
billingconfiguration
Patch matter billing configuration
curl --request PATCH \
  --url https://api.smokeball.com/matters/{matterId}/billingconfiguration \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "billingType": 1,
  "amount": 142.31,
  "contingencyAmount": 32,
  "disbursementAmount": 520.67,
  "debtorIds": [
    "<string>"
  ],
  "isUtbmsEnabled": true,
  "ledesFirmId": "100558",
  "ledesMatterId": "100558",
  "ledesClientMatterId": "100558",
  "ledesTimekeeperClassificationType": 0,
  "rateSetId": "100558"
}
'
import requests

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

payload = {
    "billingType": 1,
    "amount": 142.31,
    "contingencyAmount": 32,
    "disbursementAmount": 520.67,
    "debtorIds": ["<string>"],
    "isUtbmsEnabled": True,
    "ledesFirmId": "100558",
    "ledesMatterId": "100558",
    "ledesClientMatterId": "100558",
    "ledesTimekeeperClassificationType": 0,
    "rateSetId": "100558"
}
headers = {
    "x-api-key": "<api-key>",
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {
    'x-api-key': '<api-key>',
    Authorization: '<api-key>',
    'Content-Type': 'application/json-patch+json'
  },
  body: JSON.stringify({
    billingType: 1,
    amount: 142.31,
    contingencyAmount: 32,
    disbursementAmount: 520.67,
    debtorIds: ['<string>'],
    isUtbmsEnabled: true,
    ledesFirmId: '100558',
    ledesMatterId: '100558',
    ledesClientMatterId: '100558',
    ledesTimekeeperClassificationType: 0,
    rateSetId: '100558'
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'billingType' => 1,
    'amount' => 142.31,
    'contingencyAmount' => 32,
    'disbursementAmount' => 520.67,
    'debtorIds' => [
        '<string>'
    ],
    'isUtbmsEnabled' => true,
    'ledesFirmId' => '100558',
    'ledesMatterId' => '100558',
    'ledesClientMatterId' => '100558',
    'ledesTimekeeperClassificationType' => 0,
    'rateSetId' => '100558'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"billingType\": 1,\n  \"amount\": 142.31,\n  \"contingencyAmount\": 32,\n  \"disbursementAmount\": 520.67,\n  \"debtorIds\": [\n    \"<string>\"\n  ],\n  \"isUtbmsEnabled\": true,\n  \"ledesFirmId\": \"100558\",\n  \"ledesMatterId\": \"100558\",\n  \"ledesClientMatterId\": \"100558\",\n  \"ledesTimekeeperClassificationType\": 0,\n  \"rateSetId\": \"100558\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

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

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

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.smokeball.com/matters/{matterId}/billingconfiguration")
  .header("x-api-key", "<api-key>")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"billingType\": 1,\n  \"amount\": 142.31,\n  \"contingencyAmount\": 32,\n  \"disbursementAmount\": 520.67,\n  \"debtorIds\": [\n    \"<string>\"\n  ],\n  \"isUtbmsEnabled\": true,\n  \"ledesFirmId\": \"100558\",\n  \"ledesMatterId\": \"100558\",\n  \"ledesClientMatterId\": \"100558\",\n  \"ledesTimekeeperClassificationType\": 0,\n  \"rateSetId\": \"100558\"\n}")
  .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::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"billingType\": 1,\n  \"amount\": 142.31,\n  \"contingencyAmount\": 32,\n  \"disbursementAmount\": 520.67,\n  \"debtorIds\": [\n    \"<string>\"\n  ],\n  \"isUtbmsEnabled\": true,\n  \"ledesFirmId\": \"100558\",\n  \"ledesMatterId\": \"100558\",\n  \"ledesClientMatterId\": \"100558\",\n  \"ledesTimekeeperClassificationType\": 0,\n  \"rateSetId\": \"100558\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET"
}
{
  "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

Body

ā€‹
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, ConditionalFeeAgreement = 7

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', 'Contingency ($)' or 'Time Based'.

Example:

142.31

ā€‹
contingencyAmount
number<double>

The contingency amount (percentage).

Only applicable when BillingType is 'Contingency Percent'.

Example:

32

ā€‹
disbursementAmount
number<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.

Example:

520.67

ā€‹
debtorIds
string[] | null

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

ā€‹
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

ā€‹
rateSetId
string | null

The RateSet Id.

Only supported in the UK.

Example:

"100558"

Response

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

ā€‹
id
string | null
ā€‹
href
string | null
ā€‹
relation
string | null
ā€‹
method
string | null
default:GET