Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Activity Codes

Get an activity code

Retrieves a specified activity code.

get/activitycodes/{id}

Path parameters

idstring required

Response

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

hrefstring nullable
relationstring nullable
methodstring nullable
idstring nullable

Unique identifier of the activity.

versionIdstring nullable

Unique version identifier of the activity.

updatedByUserIdstring nullable

Unique identifier of the user that last updated the activity.

type0 | 1 | 2 | 3

Type of the activity.

Possible values: Fixed = '0', Time = '1', Expense = '2', Surcharge = '3'

descriptionstring nullable

Description of the activity.

codestring nullable

Code of the activity.

isBillableboolean

True if the activity is billable.

rateType0 | 1 | 2

The activity rate type.

Possible values: UseDefaultStaffRate = '0', OverrideRateForAllStaff = '1', OverrideRatePerStaff = '2'

ratenumber double

Rate of the activity in dollars.

If set, rate type must be OverrideRateForAllStaff

quantitynumber double

Quantity of the activity. This is the default value used when creating an expense or time-based fee.

For type 'Expense', this field represents the quantity of the expense in units. For type 'Time', this field represents the duration of in minutes, divided by 100, e.g. for 1 hour duration, quantity is 0.6, which is 60 minutes divided by 100.

Applies only for 'Time' and 'Expense' types. Not applicable for activity type 'Fixed'.

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.

taxExemptboolean

Sets tax rate to 0 for the entry (e.g. expense).

taxZeroRatedboolean

Indicates the entry is zero-rated for tax purposes. Mutually exclusive with other tax settings.

taxOutOfScopeboolean

Indicates the entry is out of scope for tax purposes. Mutually exclusive with other tax settings.

isDeletedboolean

True if the activity is deleted.

inputTaxRatenumber double nullable

Input tax rate of the activity percentage accurate to two decimal places.

outputTaxRatenumber double nullable

Output tax rate of the activity percentage accurate to two decimal places.

Example response

{
  "id": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "versionId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "description": "Contract review",
  "code": "CR",
  "isBillable": true,
  "rate": 23.2,
  "quantity": 0.6,
  "taxInclusive": true,
  "taxExempt": true,
  "isDeleted": true,
  "inputTaxRate": 45.63,
  "outputTaxRate": 45.63
}