Get activity codes

Documentation

Tutorials

APIs

GET

activitycodes

curl --request GET \
  --url https://api.smokeball.com/activitycodes \
  --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"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Authorization

string

header

required

Query Parameters

Offset

integer

Required range: 0 <= x <= 2147483647

Limit

integer

Required range: 1 <= x <= 500

UpdatedSince

integer

Returns expenses updated since a specified time (.net ticks representation of the UTC datetime).

Response

200 - application/json

When request is successful. Returns a list of 'ActivityCode' objects.

string | null

href

string | null

relation

string | null

method

string | null

default:GET

self

object

value

object[] | null

value.href

string | null

value.relation

string | null

value.method

string | null

default:GET

value.self

object

value.id

string | null

Unique identifier of the activity.

Example:

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

value.versionId

string | null

Unique version identifier of the activity.

Example:

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

value.updatedByUserId

string | null

Unique identifier of the user that last updated the activity.

Example:

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

value.type

enum<integer>

Type of the activity.

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

Available options:

0,

1,

2

Example:

0

value.description

string | null

Description of the activity.

Example:

"Contract review"

value.code

string | null

Code of the activity.

Example:

"CR"

value.isBillable

boolean

True if the activity is billable.

Example:

true

value.rateType

enum<integer>

The activity rate type.

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

Available options:

0,

1,

2

Example:

2

value.rate

number

Rate of the activity in dollars.

If set, rate type must be OverrideRateForAllStaff

Example:

23.2

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

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

value.taxExempt

boolean

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

Example:

true

value.isDeleted

boolean

True if the activity is deleted.

Example:

true

offset

integer | null

limit

integer | null

size

integer

first

object

last

object

Delete an activity code Create an activity code

curl --request GET \
  --url https://api.smokeball.com/activitycodes \
  --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"
  },
  "value": [
    {
      "href": "<string>",
      "relation": "<string>",
      "method": "GET",
      "self": {
        "id": "<string>",
        "href": "<string>",
        "relation": "<string>",
        "method": "<string>"
      },
      "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
    }
  ],
  "offset": 123,
  "limit": 123,
  "size": 123,
  "first": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "previous": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "next": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  },
  "last": {
    "id": "<string>",
    "href": "<string>",
    "relation": "<string>",
    "method": "<string>"
  }
}