GET
/
matters
/
{matterId}
/
expenses
/
{id}
Get an expense
curl --request GET \
  --url https://api.smokeball.com/matters/{matterId}/expenses/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "versionId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "createdByUserId": "8a7f40ea-4123-4ebe-bb05-e9b4b666e706",
  "staff": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "matter": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "staffId": "<string>",
  "matterId": "<string>",
  "invoiceId": "fdb766bc-eb20-4bc1-9417-08b51a7b2286",
  "origin": "<string>",
  "activityCode": "PRT",
  "utbmsTaskCode": "E101",
  "subject": "Review contract",
  "description": "Print documents",
  "expenseDate": "2022-07-01",
  "quantity": 3,
  "price": 350.32,
  "amount": 900.21,
  "amountExcTax": 810.01,
  "amountIncTax": 900.21,
  "tax": 90,
  "outputTax": 85,
  "taxInclusive": false,
  "taxZeroRated": false,
  "taxOutOfScope": false,
  "taxExempt": false,
  "finalized": false,
  "isWrittenOff": false,
  "isBillable": false,
  "isInvoicedExternally": false,
  "isDeleted": false
}

Authorizations

x-api-key
string
header
required
Authorization
string
header
required

Path Parameters

id
string
required
matterId
string
required

Response

When request is successful. Returns an 'Expense' object.

id
string | null
href
string | null
relation
string | null
method
string | null
default:GET
self
object
versionId
string | null

Unique version identifier of the expense.

Example:

"23d2a4bc-8529-462e-8560-dfbf4fa24e49"

createdByUserId
string | null

Unique identifier of the user that created the expense.

Example:

"8a7f40ea-4123-4ebe-bb05-e9b4b666e706"

staff
object

The staff member associated to the expense.

matter
object

The matter associated to the expense.

staffId
string | null

Deprecated, use Staff.

matterId
string | null

Deprecated, use Matter.

invoiceId
string | null

Unique identifier of the associated invoice.

Example:

"fdb766bc-eb20-4bc1-9417-08b51a7b2286"

origin
string | null

Where the expense originated from.

activityCode
string | null

The activity code associated to the expense.

Example:

"PRT"

utbmsTaskCode
string | null

The UTBMS task code associated to the expense, where UTBMS is enabled. Only applicable in US.

Example:

"E101"

subject
string | null

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

Example:

"Review contract"

description
string | null

Optional detailed description of the expense.

Example:

"Print documents"

expenseDate
string<date-time>

The date of the expense.

Example:

"2022-07-01"

quantity
number

The quantity of the expense in units (if not applicable, use 1).

The expense amount will be calculated as Quantity * Price.

Example:

3

price
number

The price of the expense in dollars. Limited to 2 decimal places (cents).

The expense amount will be calculated as Quantity * Price.

Example:

350.32

amount
number

Total amount of the expense. Calculated as Price * Quantity.

This amount ignores GST (if applicable). See AmountExcTax and AmountIncTax.

Example:

900.21

amountExcTax
number

Amount excluding tax. Calculated from Amount and Tax depending on the TaxInclusive property.

If tax is not applicable (outside AU), this will be the same as Amount.

Example:

810.01

amountIncTax
number

Amount including tax. Calculated from Amount and Tax depending on the TaxInclusive property.

If tax is not applicable (outside AU), this will be the same as Amount.

Example:

900.21

tax
number

GST amount of the expense in dollars. Only applicable in AU.

Example:

90

outputTax
number

Output tax amount of the expense in dollars. Only applicable in AU and UK regions.

When TaxOutOfScope or TaxZeroRated is true, this value must be 0. When TaxExempt is true, this value can be greater than 0.

Example:

85

taxInclusive
boolean

If true, the amount is GST inclusive, otherwise GST exclusive. Only applicable in AU.

GST inclusive means: Amount exc. GST = Amount - GST, Amount inc. GST = Amount.

GST exclusive means: Amount exc. GST = Amount, Amount inc. GST = Amount + GST. (Amount = Price * Quantity, GST = value of the Tax field)

Example:

false

taxZeroRated
boolean

True if the expense is zero-rated for tax purposes.

Example:

false

taxOutOfScope
boolean

True if the expense is out of scope for tax purposes.

Example:

false

taxExempt
boolean

True if the expense is exempt from tax.

Example:

false

finalized
boolean

True if the expense has been finalized.

Example:

false

isWrittenOff
boolean

True if the expense is written off. True only allowed if IsBillable is true.

Written off expenses will show on an invoice with their amount, but will not be counted in the invoice total.

Example:

false

isBillable
boolean

True if the expense is billable. Non-billable expense will, by default, not be shown on invoices (and, if shown, the amount will be 0).

Example:

false

isInvoicedExternally
boolean

True if the expense is invoiced externally.

Example:

false

isDeleted
boolean

True if the expense is deleted.

Example:

false