GET
/
activitycodes
/
{id}
curl --request GET \
  --url https://api.smokeball.com/activitycodes/{id} \
  --header 'Authorization: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "href": "<string>",
  "relation": "<string>",
  "method": "GET",
  "self": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "GET"
  },
  "id": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "versionId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "type": 0,
  "description": "Contract review",
  "code": "CR",
  "isBillable": true,
  "rateType": 2,
  "rate": 23.2,
  "quantity": 0.6,
  "taxInclusive": true,
  "taxExempt": true,
  "isDeleted": true
}

Authorizations

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

Path Parameters

​
id
string
required

Response

200
application/json
When request is successful. Returns a 'ActivityCode' object.
​
href
string | null
​
relation
string | null
​
method
string | null
default:GET
​
self
object
​
id
string | null

Unique identifier of the activity.

Example:

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

​
versionId
string | null

Unique version identifier of the activity.

Example:

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

​
updatedByUserId
string | null

Unique identifier of the user that last updated the activity.

Example:

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

​
type
enum<integer>

Type of the activity.

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

Available options:
0,
1,
2
Example:

0

​
description
string | null

Description of the activity.

Example:

"Contract review"

​
code
string | null

Code of the activity.

Example:

"CR"

​
isBillable
boolean

True if the activity is billable.

Example:

true

​
rateType
enum<integer>

The activity rate type.

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

Available options:
0,
1,
2
Example:

2

​
rate
number

Rate of the activity in dollars.

If set, rate type must be OverrideRateForAllStaff

Example:

23.2

​
quantity
number

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

Example:

0.6

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

Example:

true

​
taxExempt
boolean

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

Example:

true

​
isDeleted
boolean

True if the activity is deleted.

Example:

true