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 at the Prismatic connection.

Input	Notes	Example
Access Key password / Required accessKey	Get this by clicking Settings > Connected Apps > Manage on your app.	eyJ.....
Application ID string / Required applicationId	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 connection / Required connection
Webhook Type string / Required webhookType	The type of the Webhook.	Contact

Data Sources

Select Organization

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

Input	Notes
Connection connection / Required connection

Actions

Create a Contact

Create a new contact | key: createContact

Input	Default	Notes	Example
Additional Fields code additionalFields		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 connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Contact's First Name string / Required firstName		The first name of the Contact.	John
Contact's Last Name string / Required lastName		The last name of the Contact.	Doe

Example Payload for Create a Contact

{
  "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	Default	Notes	Example
Additional Fields code additionalFields		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 string / Required assigneeEmailAddres		The email address of the user to whom the Work Item is going to be assigned.	example@email.com
Client Key string / Required clientKey		A Karbon-generated value used to identify the existing Client (Contact, Organization or ClientGroup) for whom the Work Item is prepared.	p56mtcBhwb9
Client Type string / Required clientType		The type of the Client.	Organization
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Related Client Group Key string relatedClientGroupKey		A Karbon-generated value used to identify the Client Group of the Client.	4f3gHnLC323
Start Date string / Required startDate		The date and time at which the Work Item should start.	2022-01-30
Title string / Required title		The title of the Work Item.	Work Item Title

Example Payload for Create a Work Item

{
  "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	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
User's Email string / Required userEmail		The email of the User.	example@email.com
User's Name string / Required userName		The name of the User.	John Doe

Example Payload for Create User

{
  "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	Default	Notes
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.

Example Payload for Delete All Webhook Subscriptions

{
  "data": "Success"
}

Get Contact

Get a single Contact by Contact key | key: getContact

Input	Default	Notes	Example
Connection connection / Required connection
Contactkey string / Required contactkey		The Contact key. to get the Contact for.	4jgPTtcXxwC2
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Expand Business Cards boolean expandBusinessCards	false	Whether to return the Business Card associated with the Contact.

Example Payload for Get Contact

{
  "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	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Include Line Items boolean includeLineItems	false	Include additional lineitems invoice properties.
Invoice Key string / Required invoiceKey		The Invoice key to get the Invoice for.	M2dVbCt4RHk

Example Payload for Get Invoice

{
  "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	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
User ID string / Required userId		The unique ID of the User to get.	2bYxtn94ZSdY

Example Payload for Get User

{
  "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	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Webhook Type string / Required webhookType		The type of the Webhook.	Contact

Example Payload for Get Webhook

{
  "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	Default	Notes	Example
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Work Item Key string / Required workItemkey		The Work Item key to get the Work Item for.	2LPSrkzbYrn4

Example Payload for Get Work Item

{
  "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	Default	Notes	Example
Filter string $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 string $orderby		The property to order the results by.	FullName
Skip string $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 string $top		The number of records to return at once.	50
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Get All Data boolean getAllData	false	Turn this on to retrieve all pages of data. $top and $skip will be ignored.

Example Payload for List Contacts

{
  "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	Default	Notes	Example
Order By string $orderby		The property to order the results by.	FullName
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Include Line Items boolean includeLineItems	false	Include additional lineitems invoice properties.

Example Payload for List Invoices

{
  "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	Default	Notes	Example
Filter string $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 string $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 string $top		The number of records to return at once.	50
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Get All Data boolean getAllData	false	Turn this on to retrieve all pages of data. $top and $skip will be ignored.

Example Payload for List Users

{
  "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	Default	Notes	Example
Filter string $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 string $orderby		The property to order the results by.	FullName
Skip string $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 string $top		The number of records to return at once.	50
Connection connection / Required connection
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Get All Data boolean getAllData	false	Turn this on to retrieve all pages of data. $top and $skip will be ignored.

Example Payload for List Work Items

{
  "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	Default	Notes	Example
Connection connection / Required connection
Data string data		The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request boolean debugRequest	false	Enabling this flag will log out the current request.
File Data string Key Value List fileData		File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names string Key Value List fileDataFileNames		File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data string Key Value List formData		The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header string Key Value List headers		A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count string maxRetries	0	The maximum number of retries to attempt. Specify 0 for no retries.
Method string / Required method		The HTTP method to use.
Query Parameter string Key Value List queryParams		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 string / Required responseType	json	The type of data you expect in the response. You can request json, text, or binary data.
Retry On All Errors boolean retryAllErrors	false	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.
Retry Delay (ms) string retryDelayMS	0	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
Timeout string timeout		The maximum time that a client will await a response to its request	2000
URL string / Required 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 boolean useExponentialBackoff	false	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

Update a Contact

Partially update a contact by Contact key | key: updateContact

Input	Default	Notes	Example
Connection connection / Required connection
Contactkey string / Required contactkey		The Contact key. to update the Contact for.	4jgPTtcXxwC2
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Contact's First Name string firstName		The first name of the Contact.	John
Contact's Last Name string lastName		The last name of the Contact.	Doe
Contact's Middle Name string middleName		The middle name of the Contact.	John
Contact's Preferred Name string preferredName		The preferred name of the Contact.	John
Contact's Salutation string salutation		The title to address the Contact.	Mr
Contact's Suffix string suffix		The suffix of the Contact.	Jr.

Example Payload for Update a Contact

{
  "data": "Success"
}

Update Work Item

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

Input	Default	Notes	Example
Connection connection / Required connection
Deadline Date string deadlineDate		The deadline of the workitem as ISO8601 formated datestamp or timestamp	2022-01-30
Debug Request boolean debug	false	Enabling this flag will log out the current request.
Description string description		A free form text field to add more information about the Work Item	This is a description.
Work Item Key string / Required workItemkey		The Work Item key to update a Work Item by.	2LPSrkzbYrn4

Example Payload for Update Work Item

{
  "data": "Success"
}

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 Organization​

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​