November 27, 2023

This document provides an overview of the November 27, 2023 Karbon API release.

In this release we have added Fee Type and Fee Value on the

API endpoint - this makes it possible to set, retrieve and update Fee Settings on a Work Item.

1. JSONCopyCopied!

   POST WorkItem, PUT WorkItem
2. JSONCopyCopied!

   GET WorkItem

---

Endpoint:

When used with

and methods, this end point allows you to optionally specify a object where and can be provided.

Valid values for

are , or .

If the

is specified as or , then must be .

When

is specified as , a numerical value must be provided for .

Example use case

You want to create a Work Item to be

and have a value of 1,210.50.

Include the following JSON object in the request payload:

JSONCopyCopied!
"FeeSettings": {
  "FeeType": "FixedFee",
  "FeeValue": 1210.5000
}

Making a

request to:

---

Endpoint:

When used with

method, this end point will return a object, when have been defined on the Work Item - either through the API of the Karbon UI.

Example use case

You want to retrieve a Work Item and its Fee Settings which were previously defined in the UI in Karbon as Time and Materials. Endpoint:

This will return a JSON response with a Work Item as the payload, including the

object:

JSONCopyCopied!
"FeeSettings": {
  "FeeType": "TimeAndMaterials",
  "FeeValue": null
}