Karbon Component

Karbon is a collaborative practice management platform for accounting firms.

Component key: karbon

Description

Karbon is a collaborative practice management platform for accounting firms. Karbon aligns your team with a single place to do your best work.

Use the Karbon component to manage your accounting firms.

API Documentation

This components was built using the Karbon API Reference.

Connections

Karbon API Key

Karbon API Keys

To obtain your Application ID and Access Key Follow these steps:

Register for a Developer Account:
- Register for a free developer account to create an application in Karbon and receive the Application ID.
- Example: 00000000-0000-0000-0000-000000000000
Find Your API Access Key:
- Navigate to Settings -> Connected Apps -> Manage on your app in Karbon to find your Access Key.
- Example: eyJ.....

Use these credentials in the connection.

Input	Notes	Example
Access Key	Get this by clicking Settings > Connected Apps > Manage on your app.	eyJ.....
Application ID	The application ID for the Karbon API. You receive this when you create an application in Karbon.	00000000-0000-0000-0000-000000000000

Triggers

Entity Trigger

Get notified to this flow when a Karbon entity changes | key: entityTrigger

Input	Notes	Example
Connection
Webhook Type	The type of the Webhook.	Contact

Data Sources

Select Contact

Select a Contact from a dropdown menu | key: selectContact | type: picklist

Input	Notes	Example
Connection

Select Invoice

Select an Invoice from a dropdown menu | key: selectInvoice | type: picklist

Input	Notes	Example
Connection

Select Organization

Select an Organization from a dropdown menu | key: selectOrganization | type: picklist

Input	Notes	Example
Connection

Select User

Select a User from a dropdown menu | key: selectUser | type: picklist

Input	Notes	Example
Connection

Select Work Item

Select a Work Item from a dropdown menu | key: selectWorkItem | type: picklist

Input	Notes	Example
Connection

Actions

Create a Contact

Create a new contact | key: createContact

Input	Notes	Example
Additional Fields	Additional fields that are not covered by the standard inputs. See https://karbonhq.github.io/karbon-api-reference/#post-/v3/Contacts for more information.
Connection
Contact's First Name	The first name of the Contact.	John
Contact's Last Name	The last name of the Contact.	Doe

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Contacts/KarbonService.ContactDTO/$entity",
      "type": "#KarbonService.ContactDTO"
    },
    "ContactKey": "67zlxNyJSr8e",
    "FirstName": "William",
    "MiddleName": "John",
    "LastName": "Connor",
    "PreferredName": "Bill",
    "Salutation": "Mr",
    "Suffix": "Jr.",
    "ClientOwner": "rodney.muller@samplecompany.com",
    "ClientManager": "jessica.tse@samplecompany.com",
    "ContactType": "Client",
    "UserDefinedIdentifier": "BILLJR",
    "RestrictionLevel": "Public",
    "AvatarUrl": "https://az.karbonemail.com/images/e4ae96c1-8d17-4c6e-af8a-8040482176fc",
    "LastModifiedDateTime": "2022-07-05T07:30:13.7188114Z",
    "EntityDescription": {
      "Text": "Birthday on June 23."
    },
    "AccountingDetail": {
      "ContactPermaKey": "4XHEn8T3J4Y6",
      "OrganizationPermaKey": null,
      "BirthDate": "1969-08-05T00:00:00Z",
      "DeathDate": null,
      "Salutation": "Mr",
      "Sex": "M",
      "FinancialYearEndDay": 8,
      "FinancialYearEndMonth": 30,
      "IncorporationDate": null,
      "IncorporationState": null,
      "LegalName": null,
      "LineOfBusiness": null,
      "EntityType": null,
      "TaxCountryCode": "US",
      "TradingName": null,
      "AnnualRevenue": null,
      "BaseCurrency": null,
      "GstBasis": null,
      "GstPeriod": null,
      "IncomeTaxInstallmentPeriod": "Yearly",
      "IsVATRegistered": null,
      "OrganizationValuation": null,
      "PaysTax": null,
      "PrepareGST": null,
      "ProvisionaTaxBasic": null,
      "ProvisionalTaxRatio": null,
      "RevenueModel": null,
      "SalesTaxBasis": null,
      "SalesTaxPeriod": null,
      "Sells": null,
      "RegistrationNumbers": {
        "RegistrationNumber": "12-3456789",
        "Type": "Social Security Number (SSN)"
      },
      "Notes": {
        "Body": "This is a sample note text.",
        "Type": "Basic"
      }
    },
    "BusinessCards": {
      "BusinessCardKey": "2tBHyXtJBxBy",
      "IsPrimaryCard": true,
      "WebSites": [
        "www.website.one",
        "www.website.two"
      ],
      "EmailAddresses": [
        "sample@example.com",
        "sample.two@example.com"
      ],
      "OrganizationKey": "ZGNmtYyLm4z",
      "RoleOrTitle": "COO",
      "FacebookLink": "facebook.com/sampleName",
      "LinkedInLink": "linkedin.com/sampleName",
      "TwitterLink": "twitter.com/sampleName",
      "SkypeLink": "skype.com/sampleName",
      "Addresses": {
        "AddressKey": "e150a05a-2dea-4292-8bc8-03398c9384e4",
        "AddressLines": "45 Sample Street",
        "City": "Alexandria",
        "StateProvinceCounty": "NSW",
        "ZipCode": "2015",
        "CountryCode": "AU",
        "Label": "Physical"
      },
      "PhoneNumbers": {
        "PhoneNumberKey": "6e0b9ace-24b1-4328-a922-3b8be5ef5052",
        "Number": 1234567890,
        "CountryCode": 61,
        "Label": "Work"
      }
    }
  }
}

Create a Work Item

Create a new Work Item | key: createWorkItem

Input	Notes	Example
Additional Fields	Additional fields that are not covered by the standard inputs. See https://karbonhq.github.io/karbon-api-reference/#post-/v3/WorkItems for more information.
Assignee Email Address	The email address of the user to whom the Work Item is going to be assigned.	example@email.com
Client Key	A Karbon-generated value used to identify the existing Client (Contact, Organization or ClientGroup) for whom the Work Item is prepared.	p56mtcBhwb9
Client Type	The type of the Client.	Organization
Connection
Related Client Group Key	A Karbon-generated value used to identify the Client Group of the Client.	4f3gHnLC323
Start Date	The date and time at which the Work Item should start.	2022-01-30
Title	The title of the Work Item.	Work Item Title

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#WorkItems/KarbonService.WorkItemDTO/$entity",
      "type": "#KarbonService.WorkItemDTO"
    },
    "WorkItemKey": "2LPSrkzbYrn4",
    "AssigneeEmailAddress": "joe@samplecompany.com",
    "AssigneeKey": "4gHCvnbFFqsq",
    "AssigneeName": "Joe Min",
    "Title": "Payroll 31 Aug - 15 Sep 2022",
    "ClientKey": "4ncPZ7q96SGc",
    "ClientName": "Acme Corporation",
    "ClientType": "Organization",
    "ClientUserDefinedIdentifier": "ACMECORP",
    "RelatedClientGroupKey": "3LCPr987gNrc",
    "ClientGroupKey": "3LCPr987gNrc",
    "RelatedClientGroupName": "Smith Family Group",
    "StartDate": "2021-12-29T00:00:00Z",
    "DueDate": "2022-01-30T00:00:00Z",
    "DeadlineDate": "2022-01-31T00:00:00Z",
    "CompletedDate": "2022-02-01T00:00:00Z",
    "ToDoPeriod": "2021-12-29T00:00:00Z",
    "WorkType": "Payroll",
    "WorkStatus": "Ready To Start - Send client requests",
    "PrimaryStatus": "Ready To Start",
    "SecondaryStatus": "Send client requests",
    "WorkTemplateKey": "p56mtcBhwb9",
    "WorkTemplateTile": "Payroll processing",
    "WorkScheduleKey": "4f3gHnLC323",
    "FeeSettings": {
      "FeeType": "FixedFee",
      "FeeValue": 5150.2
    },
    "Description": "Send to Jo for review",
    "ClientTaskRecipient": null
  }
}

Create User

Create a new user | key: createUser

Input	Notes	Example
Connection
User's Email	The email of the User.	example@email.com
User's Name	The name of the User.	John Doe

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Users/$entity"
    },
    "Id": "4LR9qmR5NQ6T",
    "Name": "Joe Min",
    "EmailAddress": "joe@samplecompany.com"
  }
}

Delete All Webhook Subscriptions

Deletes all Webhook Subscriptions associated with Contact, Work, and Note | key: deleteAllWebhookSubscriptions

Input	Notes	Example
Connection

{
  "data": "Success"
}

Get Contact

Get a single Contact by Contact key | key: getContact

Input	Notes	Example
Connection
Contactkey	The Contact key. to get the Contact for.	4jgPTtcXxwC2
Expand Business Cards	Whether to return the Business Card associated with the Contact.	false

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Contacts/KarbonService.ContactDTO/$entity",
      "type": "#KarbonService.ContactDTO"
    },
    "ContactKey": "67zlxNyJSr8e",
    "FirstName": "William",
    "MiddleName": "John",
    "LastName": "Connor",
    "PreferredName": "Bill",
    "Salutation": "Mr",
    "Suffix": "Jr.",
    "ClientOwner": "rodney.muller@samplecompany.com",
    "ClientManager": "jessica.tse@samplecompany.com",
    "ContactType": "Client",
    "UserDefinedIdentifier": "BILLJR",
    "RestrictionLevel": "Public",
    "AvatarUrl": "https://az.karbonemail.com/images/e4ae96c1-8d17-4c6e-af8a-8040482176fc",
    "LastModifiedDateTime": "2022-07-05T07:30:13.7188114Z",
    "EntityDescription": {
      "Text": "Birthday on June 23."
    },
    "AccountingDetail": {
      "ContactPermaKey": "4XHEn8T3J4Y6",
      "OrganizationPermaKey": null,
      "BirthDate": "1969-08-05T00:00:00Z",
      "DeathDate": null,
      "Salutation": "Mr",
      "Sex": "M",
      "FinancialYearEndDay": 8,
      "FinancialYearEndMonth": 30,
      "IncorporationDate": null,
      "IncorporationState": null,
      "LegalName": null,
      "LineOfBusiness": null,
      "EntityType": null,
      "TaxCountryCode": "US",
      "TradingName": null,
      "AnnualRevenue": null,
      "BaseCurrency": null,
      "GstBasis": null,
      "GstPeriod": null,
      "IncomeTaxInstallmentPeriod": "Quaterly",
      "IsVATRegistered": null,
      "OrganizationValuation": null,
      "PaysTax": null,
      "PrepareGST": null,
      "ProvisionaTaxBasic": null,
      "ProvisionalTaxRatio": null,
      "RevenueModel": null,
      "SalesTaxBasis": null,
      "SalesTaxPeriod": null,
      "Sells": null,
      "RegistrationNumbers": {
        "RegistrationNumber": "12-3456789",
        "Type": "Social Security Number (SSN)"
      },
      "Notes": {
        "Body": "This is a sample note text.",
        "Type": "Basic"
      }
    },
    "BusinessCards": {
      "BusinessCardKey": "2tBHyXtJBxBy",
      "EntityType": "Contact",
      "EntityKey": "67zlxNyJSr8e",
      "IsPrimaryCard": true,
      "WebSites": [
        "www.website.one",
        "www.website.two"
      ],
      "EmailAddresses": [
        "sample@example.com",
        "sample.two@example.com"
      ],
      "OrganizationKey": "ZGNmtYyLm4z",
      "RoleOrTitle": "COO",
      "FacebookLink": "facebook.com/sampleName",
      "LinkedInLink": "linkedin.com/sampleName",
      "TwitterLink": "twitter.com/sampleName",
      "SkypeLink": "skype.com/sampleName",
      "Addresses": {
        "AddressKey": "e150a05a-2dea-4292-8bc8-03398c9384e4",
        "AddressLines": "45 Sample Street",
        "City": "Alexandria",
        "StateProvinceCounty": "NSW",
        "ZipCode": "2015",
        "CountryCode": "AU",
        "Label": "Physical"
      },
      "PhoneNumbers": {
        "PhoneNumberKey": "6e0b9ace-24b1-4328-a922-3b8be5ef5052",
        "Number": 1234567890,
        "CountryCode": 61,
        "Label": "Work"
      }
    }
  }
}

Get Invoice

Get an invoice by key | key: getInvoice

Input	Notes	Example
Connection
Include Line Items	Include additional lineitems invoice properties.	false
Invoice Key	The Invoice key to get the Invoice for.	M2dVbCt4RHk

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Invoices/$entity"
    },
    "InvoiceKey": "M2dVbCt4RHk",
    "InvoiceNumber": "KIN-1001",
    "TotalAmountDue": 1607.13,
    "InvoiceTotal": 1607.13,
    "InvoiceSubTotal": 1397.5,
    "InvoiceTaxTotal": 209.63,
    "InvoiceDate": "2023-07-21T00:00:00Z",
    "PaymentDueDate": "2023-07-28T00:00:00Z",
    "UpdatedAt": "2023-07-20T23:52:11Z",
    "CurrencyCode": "AUD",
    "PaymentInstructions": "Payment due 7 days from invoice date",
    "InvoiceStatus": "AwaitingPayment",
    "Client": {
      "ClientKey": "2xxnBLyCP4Ts",
      "ClientType": "Organization",
      "Name": "Acme Corp",
      "AddressLine": "15 Example Street",
      "City": "Sydney",
      "StateProvinceCounty": "NSW",
      "ZipCode": "4004",
      "Country": "Australia",
      "EmailAddress": "acme@example.com"
    },
    "TaxLineItems": [
      {
        "TaxName": "GST",
        "TaxValue": 209.63
      }
    ]
  }
}

Get User

Gets the details of a single User | key: getUser

Input	Notes	Example
Connection
User ID	The unique ID of the User to get.	2bYxtn94ZSdY

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Users/KarbonService.UserProfileDTO/$entity",
      "type": "#KarbonService.UserProfileDTO"
    },
    "Id": "2bYxtn94ZSdY",
    "Name": "Janet Smith",
    "EmailAddress": "janet@example.com",
    "BillableRate": 0,
    "CapacityMinutesPerWeek": 2400,
    "Permissions": [
      "User"
    ],
    "Roles": [
      "Accountant",
      "Bookkeeper"
    ],
    "Teams": [
      "Accountants",
      "Bookkeepers"
    ]
  }
}

Get Webhook

Get a webhook subscription associated with the Karbon entity specified | key: getWebhook

Input	Notes	Example
Connection
Webhook Type	The type of the Webhook.	Contact

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#WebhookSubscriptions/$entity"
    },
    "TargetUrl": "https://evelyn.info/hooks/catch/3550924/ovsbqn4/",
    "WebhookType": "Contact"
  }
}

Get Work Item

Gets a Work Item by Work Item key | key: getWorkItem

Input	Notes	Example
Connection
Work Item Key	The Work Item key to get the Work Item for.	2LPSrkzbYrn4

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#WorkItems/KarbonService.WorkItemDTO/$entity",
      "type": "#KarbonService.WorkItemDTO"
    },
    "WorkItemKey": "2LPSrkzbYrn4",
    "AssigneeEmailAddress": "joe@samplecompany.com",
    "AssigneeKey": "4gHCvnbFFqsq",
    "AssigneeName": "Joe Min",
    "Title": "Payroll 31 Aug - 15 Sep 2022",
    "ClientKey": "4ncPZ7q96SGc",
    "ClientName": "Acme Corporation",
    "ClientType": "Organization",
    "ClientUserDefinedIdentifier": "ACMECORP",
    "RelatedClientGroupKey": "3LCPr987gNrc",
    "ClientGroupKey": "3LCPr987gNrc",
    "RelatedClientGroupName": "Smith Family Group",
    "StartDate": "2021-12-29T00:00:00Z",
    "DueDate": "2022-01-30T00:00:00Z",
    "DeadlineDate": "2022-01-31T00:00:00Z",
    "CompletedDate": "2022-02-01T00:00:00Z",
    "ToDoPeriod": "2021-12-29T00:00:00Z",
    "WorkType": "Payroll",
    "WorkStatus": "Ready To Start - Send client requests",
    "PrimaryStatus": "Ready To Start",
    "SecondaryStatus": "Send client requests",
    "WorkTemplateKey": "p56mtcBhwb9",
    "WorkTemplateTile": "Payroll processing",
    "WorkScheduleKey": "4f3gHnLC323",
    "FeeSettings": {
      "FeeType": "FixedFee",
      "FeeValue": 5150.2
    },
    "Description": "Send to Jo for review",
    "ClientTaskRecipient": null
  }
}

List Contacts

List all Contacts | key: listContacts

Input	Notes	Example
Filter	A filter expression to apply to the results. See https://karbonhq.github.io/karbon-api-reference/#get-/v3/Contacts for more information.	FullName eq 'Sample Management Team'
Order By	The property to order the results by.	FullName
Skip	The number of records to skip when looping over pages of results. If you fetch 100 results, you should skip 0 the first iteration, then 100, 200, 300, etc. until no more records are available.	100
Top	The number of records to return at once.	50
Connection
Get All Data	Turn this on to retrieve all pages of data. $top and $skip will be ignored.	false

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Contacts/KarbonService.ContactSummaryDTO",
      "count": 323
    },
    "value": [
      {
        "@odata.type": "#KarbonService.ContactSummaryDTO",
        "ContactKey": "29YXnqWcqCf3",
        "FullName": "William John Connor",
        "PreferredName": "Bill",
        "Salutation": "Mr",
        "ClientOwner": "rodney.muller@samplecompany.com",
        "ClientManager": "jessica.tse@samplecompany.com",
        "Address": "42 Galaxy Way, London",
        "EmailAddress": "william.connor@samplecompany.com",
        "PhoneNumber": "0987888686",
        "RoleOrTitle": "COO",
        "UserDefinedIdentifier": "73YEnqFcqCf3",
        "LastModifiedDateTime": "2021-12-29T07:01:53Z"
      }
    ]
  }
}

List Invoices

List invoices | key: listInvoices

Input	Notes	Example
Order By	The property to order the results by.	FullName
Connection
Include Line Items	Include additional lineitems invoice properties.	false

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Invoices(LineItems())",
      "count": 1
    },
    "value": [
      {
        "InvoiceKey": "2F8bb4Xk4N1T",
        "InvoiceNumber": "KIN-1000",
        "TotalAmountDue": 5,
        "InvoiceTotal": 5,
        "InvoiceSubTotal": 5,
        "InvoiceTaxTotal": 0,
        "InvoiceDate": "2024-05-23T00:00:00Z",
        "PaymentDueDate": "2024-05-30T00:00:00Z",
        "UpdatedAt": "2024-05-23T16:44:29Z",
        "CurrencyCode": "USD",
        "PaymentInstructions": null,
        "InvoiceStatus": "Approved",
        "Client": {
          "ClientKey": "4hFn8Czrnw4v",
          "ClientType": "Organization",
          "Name": "Example Sandbox",
          "AddressLine": null,
          "City": null,
          "StateProvinceCounty": null,
          "ZipCode": null,
          "Country": null,
          "EmailAddress": null
        },
        "TaxLineItems": [],
        "LineItems": [
          {
            "LineItemKey": "3aebacb913b44aaa81b1cb2acf958b1b",
            "BillableItemEntityKey": "2SFw2p31285T",
            "BillableItemType": "Expense",
            "Description": "My Services",
            "Quantity": 1,
            "UnitPrice": 5,
            "Amount": 5,
            "TaxRate": 0,
            "TaxRateName": "No Tax Set"
          }
        ]
      }
    ]
  }
}

List Users

Get a list of Users | key: listUsers

Input	Notes	Example
Filter	A filter expression to apply to the results. See https://karbonhq.github.io/karbon-api-reference/#get-/v3/Users for more information.	FullName eq 'Sample Management Team'
Skip	The number of records to skip when looping over pages of results. If you fetch 100 results, you should skip 0 the first iteration, then 100, 200, 300, etc. until no more records are available.	100
Top	The number of records to return at once.	50
Connection
Get All Data	Turn this on to retrieve all pages of data. $top and $skip will be ignored.	false

{
  "data": {
    "odata": {
      "context": "https://api.karbonhq.com/v3/$metadata#Users",
      "count": 1,
      "nextLink": "https://api.karbonhq.com/v3/Users?$skip=100"
    },
    "value": [
      {
        "Id": "4LR9qmR5NQ6T",
        "Name": "Joe Min",
        "EmailAddress": "joe@samplecompany.com"
      }
    ]
  }
}

List Work Items

Receive a list of work items from your tenant | key: listWorkItems

Input	Notes	Example
Filter	A filter expression to apply to the results. See https://karbonhq.github.io/karbon-api-reference/#get-/v3/WorkItems for more information.	FullName eq 'Sample Management Team'
Order By	The property to order the results by.	FullName
Skip	The number of records to skip when looping over pages of results. If you fetch 100 results, you should skip 0 the first iteration, then 100, 200, 300, etc. until no more records are available.	100
Top	The number of records to return at once.	50
Connection
Get All Data	Turn this on to retrieve all pages of data. $top and $skip will be ignored.	false

{
  "data": {
    "value": [
      {
        "@odata.type": "#KarbonService.WorkItemSummaryDTO",
        "WorkItemKey": "2LPSrkzbYrn4",
        "AssigneeEmailAddress": "joe@samplecompany.com",
        "AssigneeKey": "4gHCvnbFFqsq",
        "AssigneeName": "Joe Min",
        "Title": "Payroll 31 Aug - 15 Sep 2022",
        "ClientKey": "4ncPZ7q96SGc",
        "ClientName": "Acme Corporation",
        "ClientType": "Organization",
        "ClientUserDefinedIdentifier": "ACMECORP",
        "RelatedClientGroupKey": "3LCPr987gNrc",
        "ClientGroupKey": "3LCPr987gNrc",
        "RelatedClientGroupName": "Smith Family Group",
        "StartDate": "2021-12-29T00:00:00Z",
        "DueDate": "2022-01-30T00:00:00Z",
        "DeadlineDate": "2022-01-31T00:00:00Z",
        "CompletedDate": "2022-02-01T00:00:00Z",
        "ToDoPeriod": "2021-12-29T00:00:00Z",
        "WorkType": "Payroll",
        "WorkStatus": "Ready To Start - Send client requests",
        "PrimaryStatus": "Ready To Start",
        "SecondaryStatus": "Send client requests",
        "WorkTemplateKey": "p56mtcBhwb9",
        "WorkTemplateTile": "Payroll processing",
        "WorkScheduleKey": "4f3gHnLC323"
      }
    ],
    "odata": {
      "count": 323,
      "context": "https://api.karbonhq.com/v3/$metadata#WorkItems/KarbonService.WorkItemSummaryDTO",
      "nextLink": "https://api.karbonhq.com/v3/WorkItems?$skip=100"
    }
  }
}

Raw Request

Send raw HTTP request to Karbon | key: rawRequest

Input	Notes	Example
Connection
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/v3/ClientGroups), The base URL is already included (https://api.karbonhq.com). For example, to connect to https://api.karbonhq.com/v3/ClientGroups, only /v3/ClientGroups is entered in this field.	/v3/ClientGroups
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Update a Contact

Partially update a contact by Contact key | key: updateContact

Input	Notes	Example
Connection
Contactkey	The Contact key. to update the Contact for.	4jgPTtcXxwC2
Contact's First Name	The first name of the Contact.	John
Contact's Last Name	The last name of the Contact.	Doe
Contact's Middle Name	The middle name of the Contact.	John
Contact's Preferred Name	The preferred name of the Contact.	John
Contact's Salutation	The title to address the Contact.	Mr
Contact's Suffix	The suffix of the Contact.	Jr.

{
  "data": "Success"
}

Update Work Item

Partially update a Work Item by Work Item key | key: updateWorkItem

Input	Notes	Example
Connection
Deadline Date	The deadline of the workitem as ISO8601 formated datestamp or timestamp	2022-01-30
Description	A free form text field to add more information about the Work Item	This is a description.
Work Item Key	The Work Item key to update a Work Item by.	2LPSrkzbYrn4

{
  "data": "Success"
}

Changelog

2025-10-17

Enhanced webhook lifecycle management with improved entity trigger handling and subscription management

2025-09-18

Added inline data sources for contacts, invoices, organizations, users, and work items to improve data selection and workflow integration

Karbon is a collaborative practice management platform for accounting firms.

Description​

API Documentation​

Connections​

Karbon API Key​

Karbon API Keys​

Triggers​

Entity Trigger​

Data Sources​

Select Contact​

Select Invoice​

Select Organization​

Select User​

Select Work Item​

Actions​

Create a Contact​

Create a Work Item​

Create User​

Delete All Webhook Subscriptions​

Get Contact​

Get Invoice​

Get User​

Get Webhook​

Get Work Item​

List Contacts​

List Invoices​

List Users​

List Work Items​

Raw Request​

Update a Contact​

Update Work Item​

Changelog​

2025-10-17​

2025-09-18​