v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Activity Codes

Create an activity code

Creates an activity code.

post/activitycodes

Request body

updatedByUserIdstring nullable

Unique identifier of the user updating the activity.

This field is reserved for server-to-server operations.

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. Cannot be longer than 20 characters.

isBillableboolean

True if the activity is billable.

rateType0 | 1 | 2

The activity rate type.

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

ratenumber double nullable

Rate of the activity in dollars.

If set, rateType must be OverrideRateForAllStaff

quantitynumber double nullable

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 tax inclusive, otherwise tax exclusive. Only applicable in AU and UK regions.

Tax inclusive means: Amount exc. tax = Amount - Tax, Amount inc. tax = Amount.

Tax exclusive means: Amount exc. tax = Amount, Amount inc. tax = Amount + Tax.

taxExemptboolean

True if the activity is exempt from tax.

This field is mutually exclusive with TaxZeroRated and TaxOutOfScope.

taxZeroRatedboolean

True if the activity is zero-rated for tax purposes. Only supported in UK regions.

This field is mutually exclusive with TaxOutOfScope and TaxExempt.

taxOutOfScopeboolean

True if the activity is out of scope for tax purposes. Only supported in UK regions.

This field is mutually exclusive with TaxZeroRated and TaxExempt.

inputTaxRatenumber double nullable

Input tax rate of the activity in a percentage accurate to two decimal places. e.g: 45.63

outputTaxRatenumber double nullable

Output tax rate of the activity percentage accurate to two decimal places. e.g: 45.63

Example request

{
  "updatedByUserId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "description": "Review contract",
  "code": "RC",
  "rate": 23.21,
  "quantity": 0.6
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the activity code to be created.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable