v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Expenses

Get an expense

Retrieves a specified expense.

get/matters/{matterId}/expenses/{id}

Path parameters

idstring required

matterIdstring required

Response

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

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

versionIdstring nullable

Unique version identifier of the expense.

createdByUserIdstring nullable

Unique identifier of the user that created the expense.

staffIdstring nullable

Deprecated, use Staff.

matterIdstring nullable

Deprecated, use Matter.

invoiceIdstring nullable

Unique identifier of the associated invoice.

originstring nullable

Where the expense originated from.

activityCodestring nullable

The activity code associated to the expense.

utbmsTaskCodestring nullable

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

subjectstring nullable

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

descriptionstring nullable

Optional detailed description of the expense.

expenseDatestring date-time

The date of the expense.

costTypestring

The cost type of the expense.

Hard - Direct cost such as travel, accommodation, or materials.
Soft - Indirect cost such as administrative fees or overhead.

quantitynumber double

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

The expense amount will be calculated as Quantity * Price.

pricenumber double

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

The expense amount will be calculated as Quantity * Price.

amountnumber double

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

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

amountExcTaxnumber double

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.

amountIncTaxnumber double

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.

taxnumber double

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

outputTaxnumber double

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.

taxInclusiveboolean

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)

taxZeroRatedboolean

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

taxOutOfScopeboolean

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

taxExemptboolean

True if the expense is exempt from tax.

finalizedboolean

True if the expense has been finalized.

isWrittenOffboolean

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.

isBillableboolean

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).

isInvoicedExternallyboolean

True if the expense is invoiced externally.

isDeletedboolean

True if the expense is deleted.

Example response

{
  "versionId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "createdByUserId": "8a7f40ea-4123-4ebe-bb05-e9b4b666e706",
  "invoiceId": "fdb766bc-eb20-4bc1-9417-08b51a7b2286",
  "activityCode": "PRT",
  "utbmsTaskCode": "E101",
  "subject": "Review contract",
  "description": "Print documents",
  "expenseDate": "2022-07-01",
  "costType": "Hard",
  "quantity": 3,
  "price": 350.32,
  "amount": 900.21,
  "amountExcTax": 810.01,
  "amountIncTax": 900.21,
  "tax": 90,
  "outputTax": 85
}