Module karbon

ballerinax/karbon Ballerina library

2.0.0

Overview

The Karbon connector lets Ballerina applications work with the Karbon practice management platform through its Karbon API. It supports version 3 of the API, which accounting and professional services firms use to manage clients, work, teams, time and billing.

Key features

  • Manage client records: contacts, organizations and client groups, including their business cards
  • Create, update and track work items, work schedules and work templates
  • Retrieve teams, users, roles, timesheets and individual time entries
  • Read invoices and payments, and record or reverse manual payments
  • Upload, list and download files, and attach notes and comments to client work
  • Subscribe to webhooks and manage custom fields and integration tasks

Setup guide

To use the connector, you need a Karbon account with API access enabled.

  1. Register your API application with Karbon. Karbon sends you the Application ID for it by secure message when the application is first registered.

  2. Sign in to Karbon, open Settings > Connected Apps, and copy the Access Key for your Karbon tenant.

Note: Karbon expects both values on every request. Provide them once when you create the client: the connector sends the application ID in the Authorization header (as Bearer <application ID>) and the access key in the AccessKey header. Configure the application ID on its own, without the Bearer prefix; the client code adds it.

Quickstart

To use the Karbon connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Copy
import ballerinax/karbon;

Step 2: Create a Config.toml file

Copy
token = "<Application ID, without the Bearer prefix>"
accessKey = "<Access key>"

Step 3: Create a client

Copy
configurable string token = ?;
configurable string accessKey = ?;

final karbon:Client karbonClient = check new ({authorization: "Bearer " + token, accessKey});

Step 4: Invoke an operation

Copy
public function main() returns error? {
    karbon:GetWorkItems _ = check karbonClient->listWorkItems(top = 10);
}

Examples

The Karbon connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

  1. Client onboarding workflow - Creates a client organization, opens an onboarding work item for it and leaves a note for the team.
  2. Work item status report - Pages through all work items, prints the latest ones in detail and lists the firm's teams.

Import

import ballerinax/karbon;Copy

Other versions

See more...

Metadata

Released date: 1 day ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-21 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 42

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Karbon

Area/ERP & Business Operations

Type/Connector


Contributors