karbon
Module karbon
API
Definitions
ballerinax/karbon Ballerina library
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.
-
Register your API application with Karbon. Karbon sends you the Application ID for it by secure message when the application is first registered.
-
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
Authorizationheader (asBearer <application ID>) and the access key in theAccessKeyheader. Configure the application ID on its own, without theBearerprefix; 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
import ballerinax/karbon;
Step 2: Create a Config.toml file
token = "<Application ID, without the Bearer prefix>" accessKey = "<Access key>"
Step 3: Create a client
configurable string token = ?; configurable string accessKey = ?; final karbon:Client karbonClient = check new ({authorization: "Bearer " + token, accessKey});
Step 4: Invoke an operation
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:
- Client onboarding workflow - Creates a client organization, opens an onboarding work item for it and leaves a note for the team.
- Work item status report - Pages through all work items, prints the latest ones in detail and lists the firm's teams.
Clients
karbon: Client
The Karbon API provides access to a Karbon practice-management account, including contacts, organizations, client groups, work items, timesheets, invoices and payments.
Constructor
Gets invoked to initialize the connector.
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.karbonhq.com/v3" - URL of the target service
listIntegrationTaskDefinitions
function listIntegrationTaskDefinitions(map<string|string[]> headers) returns IntegrationTaskDefinitions|errorGet a list of integration task definitions
Return Type
- IntegrationTaskDefinitions|error - The retrieved integration task definitions
listIntegrationTasks
function listIntegrationTasks(map<string|string[]> headers, *ListIntegrationTasksQueries queries) returns IntegrationTasks|errorGet a list of integration tasks
Parameters
- queries *ListIntegrationTasksQueries - Queries to be sent with the request
Return Type
- IntegrationTasks|error - The retrieved integration tasks
getIntegrationTask
function getIntegrationTask(string integrationTaskKey, map<string|string[]> headers) returns IntegrationTask|errorGet an integration task details
Parameters
- integrationTaskKey string - The unique key for a specific integration task
Return Type
- IntegrationTask|error - The retrieved integration task
updateIntegrationTask
function updateIntegrationTask(string integrationTaskKey, IntegrationTaskWriteable payload, map<string|string[]> headers) returns error?Update an integration task
Parameters
- integrationTaskKey string - The unique key for a specific integration task
- payload IntegrationTaskWriteable - An integration task request body
Return Type
- error? - No Content
listInvoices
function listInvoices(map<string|string[]> headers, *ListInvoicesQueries queries) returns InvoiceList|errorGets a list of Invoices
Parameters
- queries *ListInvoicesQueries - Queries to be sent with the request
Return Type
- InvoiceList|error - Successful Invoices GET operation
getInvoice
function getInvoice(string invoiceKey, map<string|string[]> headers, *GetInvoiceQueries queries) returns InvoiceResponse|errorGets a single Invoice
Parameters
- invoiceKey string - The Karbon-generated Invoice key
- queries *GetInvoiceQueries - Queries to be sent with the request
Return Type
- InvoiceResponse|error - Successful Invoice GET operation
listPayments
function listPayments(map<string|string[]> headers, *ListPaymentsQueries queries) returns PaymentList|errorGets a list of Payments
Parameters
- queries *ListPaymentsQueries - Queries to be sent with the request
Return Type
- PaymentList|error - Successful Payments GET operation
createManualPayment
function createManualPayment(CreateManualPaymentRequest payload, map<string|string[]> headers) returns ManualPaymentResponse|errorCreate a manual payment against an Invoice
Parameters
- payload CreateManualPaymentRequest - A manual payment request body
Return Type
- ManualPaymentResponse|error - Manual Payment recorded successfully
deleteManualPayment
Delete a manual payment
Parameters
- manualPaymentKey string - The Manual Payment key
Return Type
- error? - No Content
reverseManualPayment
function reverseManualPayment(ReverseManualPaymentRequest payload, map<string|string[]> headers) returns error?Reverse a manual payment
Parameters
- payload ReverseManualPaymentRequest - A reverse manual payment request body
Return Type
- error? - No Content
getPayment
Gets a single Payment
Parameters
- paymentKey string - The unique key of the payment
Return Type
- PaymentResponse|error - Successful Payment GET operation
getBusinessCard
function getBusinessCard(string businessCardKey, map<string|string[]> headers) returns BusinessCardResponse|errorGets a single Business Card
Parameters
- businessCardKey string - The Karbon-generated Business Card key
Return Type
- BusinessCardResponse|error - Successful operation
updateBusinessCard
function updateBusinessCard(string businessCardKey, UpdateBusinessCardRequest payload, map<string|string[]> headers) returns error?Updates a single Business Card
Parameters
- businessCardKey string - The Karbon-generated Business Card key
- payload UpdateBusinessCardRequest - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
listClientGroups
function listClientGroups(map<string|string[]> headers, *ListClientGroupsQueries queries) returns GetClientGroup|errorGets a list of Client Groups
Parameters
- queries *ListClientGroupsQueries - Queries to be sent with the request
Return Type
- GetClientGroup|error - Successful operation
createClientGroup
function createClientGroup(CreateClientGroupRequest payload, map<string|string[]> headers) returns ClientGroupDetails|errorCreates a new Client Group
Parameters
- payload CreateClientGroupRequest - Refer to the table below for more information on each field in the request body
Return Type
- ClientGroupDetails|error - Successful operation
getClientGroupByIdentifier
function getClientGroupByIdentifier(string userDefinedIdentifier, map<string|string[]> headers, *GetClientGroupByIdentifierQueries queries) returns ClientGroupDetails|errorGets a Client Group using UserDefinedIdentifier
Parameters
- userDefinedIdentifier string - A unique identifier that you had created to identify this Client Group. This parameter is not case sensitive
- queries *GetClientGroupByIdentifierQueries - Queries to be sent with the request
Return Type
- ClientGroupDetails|error - Successful operation
getClientGroup
function getClientGroup(string clientGroupkey, map<string|string[]> headers, *GetClientGroupQueries queries) returns ClientGroupDetails|errorGets a Client Group using ClientGroupkey
Parameters
- clientGroupkey string - The Karbon-generated Client Group key
- queries *GetClientGroupQueries - Queries to be sent with the request
Return Type
- ClientGroupDetails|error - Successful operation
updateClientGroup
function updateClientGroup(string clientGroupkey, UpdateClientGroupRequest payload, map<string|string[]> headers) returns error?Updates a Client Group (Full)
Parameters
- clientGroupkey string - The Karbon-generated Client Group key
- payload UpdateClientGroupRequest - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
partiallyUpdateClientGroup
function partiallyUpdateClientGroup(string clientGroupkey, PartialClientGroupUpdateRequest payload, map<string|string[]> headers) returns error?Updates a Client Group (Partial)
Parameters
- clientGroupkey string - The Karbon-generated Client Group key
- payload PartialClientGroupUpdateRequest - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
getComment
Gets a Comment using CommentKey
Parameters
- commentkey string - A Karbon-generated unique value that is used to identify the comment
Return Type
- GetComment|error - OK
listContacts
function listContacts(map<string|string[]> headers, *ListContactsQueries queries) returns GetContacts|errorGets a list of Contacts
Parameters
- queries *ListContactsQueries - Queries to be sent with the request
Return Type
- GetContacts|error - Successful operation
createContact
function createContact(CreateContact payload, map<string|string[]> headers) returns ResponseCreateContact|errorCreates a new Contact
Parameters
- payload CreateContact - Refer to the table below for more information on each field in the request body
Return Type
- ResponseCreateContact|error - Created
getContactByIdentifier
function getContactByIdentifier(string userDefinedIdentifier, map<string|string[]> headers, *GetContactByIdentifierQueries queries) returns ResponseCreateContact|errorGets a Contact using UserDefinedIdentifier
Parameters
- userDefinedIdentifier string - A unique identifier that you had created to identify this Contact. This parameter is not case sensitive
- queries *GetContactByIdentifierQueries - Queries to be sent with the request
Return Type
- ResponseCreateContact|error - Successful operation
getContact
function getContact(string contactkey, map<string|string[]> headers, *GetContactQueries queries) returns ResponseCreateContact|errorGets a Contact using Contactkey
Parameters
- contactkey string - The Karbon-generated Contact key
- queries *GetContactQueries - Queries to be sent with the request
Return Type
- ResponseCreateContact|error - Successful operation
updateContact
function updateContact(string contactkey, CreateContact payload, map<string|string[]> headers) returns error?Updates a Contact (Full)
Parameters
- contactkey string - The Karbon-generated Contact key
- payload CreateContact - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
partiallyUpdateContact
function partiallyUpdateContact(string contactkey, PartialContactUpdateRequest payload, map<string|string[]> headers) returns PartiallyUpdatedContact|errorUpdates a Contact (Partial)
Parameters
- contactkey string - The Karbon-generated Contact key
- payload PartialContactUpdateRequest - Refer to the table below for more information on each field in the request body
Return Type
listCustomFieldDefinitions
function listCustomFieldDefinitions(map<string|string[]> headers) returns CustomFieldDefinitions|errorGets all custom field definitions for the current tenant
Return Type
createCustomFieldDefinition
function createCustomFieldDefinition(CustomFieldDefinition payload, map<string|string[]> headers) returns CustomFieldDefinition|errorCreates a new custom field definition
Parameters
- payload CustomFieldDefinition - The payload sent to create a new Custom Field
Return Type
- CustomFieldDefinition|error - Custom field definition successfully created
deleteCustomFieldDefinition
function deleteCustomFieldDefinition(string customFieldDefinitionKey, map<string|string[]> headers) returns error?Deletes a custom field definition by key
Parameters
- customFieldDefinitionKey string - The key of the custom field definition to delete
Return Type
- error? - Custom field definition successfully deleted
getCustomFieldValues
function getCustomFieldValues(string entityKey, map<string|string[]> headers) returns CustomFieldValues|errorGets custom field values for a specific entity
Parameters
- entityKey string - The key to get custom field values for a Contact or Organization
Return Type
- CustomFieldValues|error - OK
updateCustomFieldValues
function updateCustomFieldValues(string entityKey, CustomFieldValues payload, map<string|string[]> headers) returns error?Updates custom field values for a specific entity
Parameters
- entityKey string - The key to get custom field values for a Contact or Organization
- payload CustomFieldValues - The payload sent when updating the custom fields on a Contact or Organization
Return Type
- error? - Custom field values successfully updated
listEstimateSummaries
function listEstimateSummaries(string workItemKey, map<string|string[]> headers) returns EstimateSummaryList|errorGets estimate summaries using WorkItemKey
Parameters
- workItemKey string - The Karbon-generated Work Item key
Return Type
- EstimateSummaryList|error - Successful operation
getEstimateSummary
function getEstimateSummary(string workItemKey, string estimateSummaryKey, map<string|string[]> headers) returns EstimateSummary|errorGets a single Estimate Summary using WorkItemKey and EstimateSummaryKey
Parameters
- workItemKey string - The Karbon-generated Work Item key
- estimateSummaryKey string - The Karbon-generated Estimate Summary key, as returned by GET /v3/EstimateSummaries/{WorkItemKey}
Return Type
- EstimateSummary|error - Successful operation
updateEstimateSummary
function updateEstimateSummary(string workItemKey, string estimateSummaryKey, UpdateEstimateSummaryRequest payload, map<string|string[]> headers) returns error?Updates a single Estimate Summary
Parameters
- workItemKey string - The Karbon-generated Work Item key
- estimateSummaryKey string - The Karbon-generated Estimate Summary key, as returned by GET /v3/EstimateSummaries/{WorkItemKey}
- payload UpdateEstimateSummaryRequest - The fields to update. Only EstimateMinutes, EstimateAmount and HourlyRate are accepted, and EstimateMinutes and EstimateAmount cannot be supplied together. Refer to the table below for more information on each field in the request body
Return Type
- error? - Estimate summary successfully updated
createExpense
function createExpense(ExpenseRequest payload, map<string|string[]> headers) returns ExpenseResponse|errorCreates a new Expense
Parameters
- payload ExpenseRequest - Refer to the table below for more information on each field in the request body
Return Type
- ExpenseResponse|error - Created
downloadFile
function downloadFile(map<string|string[]> headers, *DownloadFileQueries queries) returns byte[]|errorGet a File using it's token
Parameters
- queries *DownloadFileQueries - Queries to be sent with the request
Return Type
- byte[]|error - OK
uploadFile
function uploadFile(UploadFileRequest payload, map<string|string[]> headers) returns UploadedFile|errorUploads and links a file
Parameters
- payload UploadFileRequest - Refer to the table below for more information on each field in the request body
Return Type
- UploadedFile|error - Created
getFileDetails
Get the details of a single File
Parameters
- 'key string - The FileContextKey of the file to retrieve
Return Type
- FileListItem|error - OK
downloadFileByKey
Redirect to download a single File
Parameters
- 'key string - The FileContextKey of the file to download
Return Type
- error? - Found — redirects to a freshly-tokened download URL for the file
listFiles
function listFiles("WorkItem"|"Contact"|"Organization" entityType, map<string|string[]> headers, *ListFilesQueries queries) returns FileList|errorGet a list of Files for a given entity
Parameters
- entityType "WorkItem"|"Contact"|"Organization" - The entity type related to the entity key
- queries *ListFilesQueries - Queries to be sent with the request
getNote
Gets a Note using NoteID
Parameters
- noteID string - The Karbon-generated Note key
Return Type
- NoteResponse|error - Successful operation
createNote
function createNote(NoteRequest payload, map<string|string[]> headers) returns NoteResponse|errorCreates a new Note
Parameters
- payload NoteRequest - Refer to the table below for more information on each field in the request body
Return Type
- NoteResponse|error - Created
listOrganizations
function listOrganizations(map<string|string[]> headers, *ListOrganizationsQueries queries) returns GetOrganizations|errorGets a list of Organizations
Parameters
- queries *ListOrganizationsQueries - Queries to be sent with the request
Return Type
- GetOrganizations|error - Successful operation
createOrganization
function createOrganization(CreateOrganization payload, map<string|string[]> headers) returns CreateOrganizationResponse|errorCreates a new Organization
Parameters
- payload CreateOrganization - Refer to the table below for more information on each field in the request body
Return Type
- CreateOrganizationResponse|error - Created
getOrganizationByIdentifier
function getOrganizationByIdentifier(string userDefinedIdentifier, map<string|string[]> headers, *GetOrganizationByIdentifierQueries queries) returns WithBusinessCardsCreateOrganizationResponse|errorGets an Organization using UserDefinedIdentifier
Parameters
- userDefinedIdentifier string - A unique identifier that you had created to identify this Organization. This parameter is not case sensitive
- queries *GetOrganizationByIdentifierQueries - Queries to be sent with the request
Return Type
- WithBusinessCardsCreateOrganizationResponse|error - Successful operation
getOrganization
function getOrganization(string organizationkey, map<string|string[]> headers, *GetOrganizationQueries queries) returns OrganizationDetails|errorGets an Organization using Organizationkey
Parameters
- organizationkey string - The Karbon-generated Organization key
- queries *GetOrganizationQueries - Queries to be sent with the request
Return Type
- OrganizationDetails|error - Successful operation
updateOrganization
function updateOrganization(string organizationkey, UpdateOrganization payload, map<string|string[]> headers) returns error?Updates an Organization (Full)
Parameters
- organizationkey string - The Karbon-generated Organization key
- payload UpdateOrganization - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
partiallyUpdateOrganization
function partiallyUpdateOrganization(string organizationkey, PartialOrganizationUpdateRequest payload, PartiallyUpdateOrganizationHeaders headers) returns PartiallyUpdatedOrganization|errorUpdates an Organization (Partial)
Parameters
- organizationkey string - The Karbon-generated Organization key
- payload PartialOrganizationUpdateRequest - Refer to the table below for more information on each field in the request body
- headers PartiallyUpdateOrganizationHeaders (default {}) - Headers to be sent with the request
Return Type
listRoles
Gets a list of Roles
Parameters
- queries *ListRolesQueries - Queries to be sent with the request
listTeams
Gets a list of Teams
Parameters
- queries *ListTeamsQueries - Queries to be sent with the request
getTeam
Gets a single Team, including its members
Parameters
- teamKey string - The key of the Team to retrieve
Return Type
- TeamProfile|error - OK
addTeamMembers
function addTeamMembers(string teamKey, AddTeamMembers payload, map<string|string[]> headers) returns error?Adds one or more members to a Team
Parameters
- teamKey string - The key of the Team to add members to
- payload AddTeamMembers - The user profile keys to add as members of the Team
Return Type
- error? - No Content
removeTeamMember
function removeTeamMember(string teamKey, RemoveTeamMember payload, map<string|string[]> headers) returns error?Removes a member from a Team
Parameters
- teamKey string - The key of the Team to remove a member from
- payload RemoveTeamMember - The user profile key to remove from the Team
Return Type
- error? - No Content
getTenantSettings
function getTenantSettings(map<string|string[]> headers) returns GetTenantSettings|errorGets lists of customer specific Contact and Work settings
Return Type
- GetTenantSettings|error - Successful operation
listTimesheets
function listTimesheets(map<string|string[]> headers, *ListTimesheetsQueries queries) returns GetTimeSheets|errorGets a list of Timesheets
Parameters
- queries *ListTimesheetsQueries - Queries to be sent with the request
Return Type
- GetTimeSheets|error - Successful operation
Deprecated
getTimesheet
function getTimesheet(string timesheetkey, map<string|string[]> headers, *GetTimesheetQueries queries) returns TimesheetResponse|errorGets a Timesheets using Timesheetkey
Parameters
- timesheetkey string - The Karbon-generated Timesheet key
- queries *GetTimesheetQueries - Queries to be sent with the request
Return Type
- TimesheetResponse|error - Successful operation
Deprecated
listIndividualTimeEntries
function listIndividualTimeEntries(map<string|string[]> headers, *ListIndividualTimeEntriesQueries queries) returns GetIndividualTimeEntries|errorGets a list of individual time entries
Parameters
- queries *ListIndividualTimeEntriesQueries - Queries to be sent with the request
Return Type
- GetIndividualTimeEntries|error - Successful operation
getIndividualTimeEntry
function getIndividualTimeEntry(string individualTimeEntryKey, map<string|string[]> headers) returns IndividualTimeEntryResponse|errorGets an individual time entry by key
Parameters
- individualTimeEntryKey string - The Karbon-generated GUID key for the individual time entry (32-character hex string, no hyphens)
Return Type
- IndividualTimeEntryResponse|error - Successful operation
listUsers
Gets a list of Users
Parameters
- queries *ListUsersQueries - Queries to be sent with the request
createUser
function createUser(CreateUserRequest payload, map<string|string[]> headers) returns UserResponse|errorCreates a new User
Parameters
- payload CreateUserRequest - Refer to the table below for more information on each field in the request body
Return Type
- UserResponse|error - Successful operation
getUser
Gets the details of a single User
Parameters
- userId string - The unique ID of the User to get
Return Type
- GetUserById|error - Successful operation
getWebhookSubscription
function getWebhookSubscription("Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary"|"Multi" webhookType, map<string|string[]> headers) returns GetWebhookSubscriptions|errorGets a Webhook Subscription
Parameters
- webhookType "Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary"|"Multi" - The type of Karbon entity, which the Webhook Subscription must be associated with. Use
Multito retrieve the multi-type subscription created viaWebhookTypes
Return Type
- GetWebhookSubscriptions|error - Successful operation
deleteWebhookSubscription
function deleteWebhookSubscription("Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary"|"Multi" webhookType, map<string|string[]> headers) returns error?Deletes a Webhook Subscription
Parameters
- webhookType "Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary"|"Multi" - The type of Karbon entity, which the Webhook Subscription must be associated with. Use
Multito delete the multi-type subscription created viaWebhookTypes
Return Type
- error? - No Content
updateWebhookSubscription
function updateWebhookSubscription("Multi" webhookType, UpdateWebhookSubscriptionRequest payload, map<string|string[]> headers) returns error?Updates the multi-type Webhook Subscription's subscribed types
Parameters
- webhookType "Multi" - Must be
Multi— this action only applies to the multi-type Webhook Subscription
- payload UpdateWebhookSubscriptionRequest - The full replacement set of subscribed resource types
Return Type
- error? - No Content
createWebhookSubscription
function createWebhookSubscription(CreateWebhookSubscriptionRequest payload, map<string|string[]> headers) returns GetWebhookSubscriptions|errorCreates a new Webhook Subscription
Parameters
- payload CreateWebhookSubscriptionRequest - Refer to the table below for more information on each field in the request body. Provide either
WebhookType(single-type subscription) orWebhookTypes(multi-type subscription) — not both
Return Type
- GetWebhookSubscriptions|error - Created
deleteAllWebhookSubscriptions
Deletes all Webhook Subscriptions
Return Type
- error? - No Content
listWorkItems
function listWorkItems(map<string|string[]> headers, *ListWorkItemsQueries queries) returns GetWorkItems|errorGets a list of Work Items
Parameters
- queries *ListWorkItemsQueries - Queries to be sent with the request
Return Type
- GetWorkItems|error - Successful operation
createWorkItem
function createWorkItem(CreateWorkItemRequest payload, map<string|string[]> headers) returns CreatedWorkItem|errorCreates a new Work Item
Parameters
- payload CreateWorkItemRequest - Refer to the table below for more information on each field in the request body
Return Type
- CreatedWorkItem|error - Created
getWorkItem
function getWorkItem(string workItemKey, map<string|string[]> headers) returns WorkItemDetails|errorGets a Work Item using WorkItemKey
Parameters
- workItemKey string - The Karbon-generated Work Item key
Return Type
- WorkItemDetails|error - Successful operation
updateWorkItem
function updateWorkItem(string workItemKey, CreateWorkItemRequest payload, map<string|string[]> headers) returns error?Updates a Work Item (Full)
Parameters
- workItemKey string - The Karbon-generated Work Item key
- payload CreateWorkItemRequest - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
partiallyUpdateWorkItem
function partiallyUpdateWorkItem(string workItemKey, UpdateWorkItem payload, map<string|string[]> headers) returns error?Updates a Work Item (Partial)
Parameters
- workItemKey string - The Karbon-generated Work Item key
- payload UpdateWorkItem - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
createWorkSchedule
function createWorkSchedule(WorkScheduleRequest payload, map<string|string[]> headers) returns GetWorkSchedule|errorCreates a new Work Schedule
Parameters
- payload WorkScheduleRequest - Refer to the table below for more information on each field in the request body
Return Type
- GetWorkSchedule|error - Created
getWorkSchedule
function getWorkSchedule(string workSchedulekey, map<string|string[]> headers) returns GetWorkSchedule|errorGets a Work Schedule using WorkSchedulekey
Parameters
- workSchedulekey string - The Karbon-generated Work Schedule key
Return Type
- GetWorkSchedule|error - Successful operation
updateWorkSchedule
function updateWorkSchedule(string workSchedulekey, UpdateWorkScheduleRequest payload, map<string|string[]> headers) returns error?Updates a Work Schedule (Full)
Parameters
- workSchedulekey string - The Karbon-generated Work Schedule key
- payload UpdateWorkScheduleRequest - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
partiallyUpdateWorkSchedule
function partiallyUpdateWorkSchedule(string workSchedulekey, UpdateWorkSchedule payload, map<string|string[]> headers) returns error?Updates a Work Schedule (Partial)
Parameters
- workSchedulekey string - The Karbon-generated Work Schedule key
- payload UpdateWorkSchedule - Refer to the table below for more information on each field in the request body
Return Type
- error? - No Content
listWorkTemplates
function listWorkTemplates(map<string|string[]> headers, *ListWorkTemplatesQueries queries) returns GetWorkTemplates|errorGets a list of Work Templates
Parameters
- queries *ListWorkTemplatesQueries - Queries to be sent with the request
Return Type
- GetWorkTemplates|error - Successful operation
getWorkTemplate
function getWorkTemplate(string workTemplatekey, map<string|string[]> headers) returns WorkTemplateResponse|errorGets a Work Template using WorkTemplatekey
Parameters
- workTemplatekey string - The Karbon-generated Work Template key
Return Type
- WorkTemplateResponse|error - Successful operation
Records
karbon: AccountingNote
Fields
- 'type "Basic"|"Tax"|"System"|"Owner"|"Officer" - The section (within the accounting details) where the note resides
- body string - The free-form text in the note
karbon: AccountingRegistrationNumber
Fields
- 'type "Australian Business Number (ABN)"|"Australian Company Number (ACN)"|"Tax File Number (TFN)"|"Social Security Number (SSN)"|"Tax ID"|"VAT Number"|"Company Registration Number"|"PAYE Reference Number"|"PAYE Accounts Office Reference"|"CT Reference"|"Unique Taxpayer Reference (UTR)"|"NZ Business Number"|"GST Number"|"IRD Number"|"Business Number"|"Social Insurance Number (SIN)"|"Registration Number"|"Income Tax Number"|"PAYE Number"|"DOL UIF Number"|"SDL Number"|"DOL Workman Compensation"|"Company Number"|"Business Registration Number"|"Charity Number"|"MPF provider"|"RCS"|"SIRET"|"UEN"|"RCT Reference"|"Companies Office Number"|"KUND ID"|"Organisation Number"|"Finnish Business ID"|"CVR Number"|"GST Identification Number (GSTIN)"|"Permanent Account Number (PAN)" - The type of registration
- registrationNumber string - The registration number
karbon: AddTeamMembers
The user profile keys to add as members of a Team
Fields
- userKeys string[] - The keys of the users to add. Must be non-empty. Users already on the Team are skipped
karbon: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- authorization string - The Application ID for your API application, supplied by secure message when your Application is first registered. Send it as
Bearer <application ID>
- accessKey string - The AccessKey for your API application, found inside the Settings > Connected Apps section in Karbon
karbon: BillingBaseInvoice
A Karbon invoice
Fields
- invoiceTaxTotal decimal - Total of the taxes on the invoice
- currencyCode string - A three letter ISO 4217 currency code denoting the currency used in the invoice, e.g. AUD, USD, CAD, NZD, EUR, GBP
- invoiceTotal decimal - Invoice total, including taxes
- invoiceKey string - The unique key assigned to an invoice by Karbon
- invoiceSubTotal decimal - The sum of the line items of the invoice, excluding taxes
- invoiceNumber string - The invoice number of the invoice
- invoiceDate string - The date the invoice was issued as an ISO 8601 timestamp
- paymentInstructions? string? - Payment instructions added to the invoice
- updatedAt string - A timestamp showing when the invoice was last updated as an ISO 8601 timestamp
- invoiceStatus "Approved"|"AwaitingPayment"|"Paid"|"Exported"|"Voided" - Current status of the invoice
- totalAmountDue decimal - Remaining amount due on the invoice, including taxes minus any payments
- paymentDueDate string - The date the invoice is due as an ISO 8601 timestamp
karbon: BillingClient
The details of the invoice recipient at the point in time the invoice was drafted or payment creator at the point the payment was received
Fields
- Client BillingClientClient? - The Karbon Client Billing Contact
karbon: BillingClientClient
The Karbon Client Billing Contact
Fields
- clientType? string - The client type, e.g. Contact or Organization
- addressLine? string - The billing address of the cient at the point the invoice was drafted
- zipCode? string - The billing address zip/postal code of the cient at the point the invoice was drafted
- clientKey? string - The unique key of the billed Client
- country? string - The billing address country of the cient at the point the invoice was drafted
- city? string - The billing address city of the cient at the point the invoice was drafted
- stateProvinceCounty? string - The billing address state/province/country of the cient at the point the invoice was drafted
- emailAddress? string - The billing email address of the cient at the point the invoice was drafted
- name? string - The name of the client at the point the invoice was drafted
karbon: BillingInvoice
A Karbon Invoice record
Fields
- Fields Included from *BillingBaseInvoice
- invoiceTaxTotal decimal
- currencyCode string
- invoiceTotal decimal
- invoiceKey string
- invoiceSubTotal decimal
- invoiceNumber string
- invoiceDate string
- paymentInstructions string|()
- updatedAt string
- invoiceStatus "Approved"|"AwaitingPayment"|"Paid"|"Exported"|"Voided"
- totalAmountDue decimal
- paymentDueDate string
- anydata...
- Fields Included from *BillingClient
- Client BillingClientClient|()
- anydata...
- Fields Included from *BillingTaxLineItems
- taxLineItems BillingTaxLineItem[]
- anydata...
karbon: BillingInvoiceData
A collection of the data associated with an invoice
Fields
- data? BillingInvoiceDataItem[] - The collection of data that is used to create the rendered (HTML/PDF) invoice sent to the billing contact
karbon: BillingInvoiceDataExpense
A line item on a Karbon invoice
Fields
- expenses? BillingInvoiceDataExpenseItem[] -
- billed? decimal - The total billed value of expenses
karbon: BillingInvoiceDataExpenseItem
An expense line item on a Karbon invoice
Fields
- description? string - The description of the expense
- expenseKey? string -
- billed? decimal - An the billed value of a specific expense
- Fields Included from *BillingInvoiceDataTax
karbon: BillingInvoiceDataItem
A single component of the data used to create the rendered (HTML/PDF) invoice
Fields
- entityType? string - The type of the source of the billing
- entityKey? string - The unique key of the source of the billing
- expenses? BillingInvoiceDataExpense -
- work? BillingInvoiceDataWork? -
- 'service? BillingInvoiceDataService? -
- billed? decimal - The value of the billed amount
karbon: BillingInvoiceDataService
A service line item on a Karbon invoice
Fields
- workType? string - The work type associated with the service
- billed? decimal - The billed value of the service
- Fields Included from *BillingInvoiceDataTax
karbon: BillingInvoiceDataTax
A breakdown of tax related to invoice, lineitems and data
Fields
- taxAmount? decimal? - The value of tax component in the billed amount
- taxRateName? string? - The name of the tax rate applied to the billed amount
- taxRate? decimal? - The tax rated applied to the billed amount
karbon: BillingInvoiceDataWork
The breakdown of the billing that stems from work
Fields
- feeType? string - The fee type of the billed amount
- workType? string - The tax rated applied to the billed amount
- billed? decimal - The value of the billed amount
- timeEntries? anydata -
- invoiceType? string - Denotes whether the invoice is final or not
- Fields Included from *BillingInvoiceDataTax
karbon: BillingInvoiceDataWorkTimeEntry
The details of an invoiced time entry
Fields
- TimeEntryKey? string - The unique identifier of the time entry
- ColleagueKey? string - The unique ID of the user that logged the time
- RoleName? string - The role on the time entry
- TaskTypeName? string - The task ype on the time entry
- Billed? decimal - The billed value of the time entry
karbon: BillingInvoiceLineItem
A line item on a Karbon invoice
Fields
- unitPrice? string - The per unit price of the line item
- billableItemEntityKey? string - The unique key of the related entity the line item was created from, could be a Contact, WorkItem or TimeEntry
- description? string - The description of charge the line item covers
- taxRateName? string? - The user specified name of tax rate, e.g. GST, VAT, PST
- lineItemKey? string - A unique GUID for the line item
- amount? decimal - The amount of the line item calculated as UnitPrice * Quantity, excluding taxes
- taxRate? decimal? - The percentage tax rate, expressed as an integer - e.g. 15% is rendered as 15.0000
- quantity? decimal - The quantity of units for a line item
- billableItemType? "TimeEntry"|"Expense"|"Entity" - The source type of the line item
karbon: BillingInvoiceLineItems
A breakdown of line items from the invoice
Fields
- lineItems BillingInvoiceLineItem[] - An array of invoice line items
karbon: BillingInvoicePayment
A payment on a Karbon invoice
Fields
- paymentReference? string - The Karbon reference number for the payment
- paymentDate? string - The datestamp the payment was made, for manual payments this is the date only
- amount? decimal - The value of the payment
- paymentType? "ManualPayment"|"ManualPaymentReversed"|"Payment" - The type of payment
- paymentKey? string - A unique ID for the payment
karbon: BillingInvoicePayments
Details of the payments related to the invoice
Fields
- payments BillingInvoicePayment[] - An array of invoice payments
karbon: BillingInvoiceWithPayment
A Karbon invoice with associated payment records
Fields
- Fields Included from *BillingInvoice
- invoiceTaxTotal decimal
- currencyCode string
- invoiceTotal decimal
- invoiceKey string
- invoiceSubTotal decimal
- invoiceNumber string
- invoiceDate string
- paymentInstructions string|()
- updatedAt string
- invoiceStatus "Approved"|"AwaitingPayment"|"Paid"|"Exported"|"Voided"
- totalAmountDue decimal
- paymentDueDate string
- Client BillingClientClient|()
- taxLineItems BillingTaxLineItem[]
- anydata...
- Fields Included from *BillingInvoiceLineItems
- lineItems BillingInvoiceLineItem[]
- anydata...
- Fields Included from *BillingInvoicePayments
- payments BillingInvoicePayment[]
- anydata...
- Fields Included from *BillingInvoiceData
- data BillingInvoiceDataItem[]
- anydata...
karbon: BillingKarbonPayment
The Karbon Payment object
Fields
- karbonPayment? BillingKarbonPaymentKarbonPayment -
karbon: BillingKarbonPaymentKarbonPayment
Data specific to Karbon Payments
Fields
- payoutStatus? string - A status indicating whether the payment has been payed out
- cardType? string - The type of the paying card
- netAmount? decimal - The gross amount less surcharges, fees and taxes
- cardFunding? string -
- surchargeTaxAmount? decimal - The tax on any surcharge(s)
- cardCountry? string? - The country the paying card was issued in
- surchargeAmount? decimal - The amount of anr surcharge(s)
- karbonFeeAmount? decimal - The amount of the Karbon fee
- karbonFeeTaxAmount? decimal - The tax on the Karbon fee
karbon: BillingPayment
A Karbon Payment record
Fields
- paymentReference string - The Karbon reference number of the payment
- paymentDate string - The datestamp the payment was made, for Manual Payments this will be a datestamp
- clientKey? string - The unique key of the client that payment was by - could be a Person or Organization
- paymentType "ManualPayment"|"ManualPaymentReversed"|"Payment" - The type of payment
- paymentMethod string - The method by which the payment was made
- paymentKey string - The unique key assigned to an payment by Karbon
- grossAmount decimal - The valeu of the payment, excluding fees and taxes
- Fields Included from *BillingKarbonPayment
- karbonPayment BillingKarbonPaymentKarbonPayment
- anydata...
- Fields Included from *BillingClient
- Client BillingClientClient|()
- anydata...
karbon: BillingTaxLineItem
A tax line item detailing the tax code and amount on Karbon invoice
Fields
- TaxName? string - The name of the tax
- TaxValue? decimal - The value of the tax in the invoice currency
karbon: BillingTaxLineItems
Details of the tax components of the invoice
Fields
- taxLineItems? BillingTaxLineItem[] - An array of tax types and values from invoice line items
karbon: BusinessCard
A business card associated with a contact or organization
Fields
- webSites? string[] - The websites associated with this Business card
- skypeLink? string - The URL to the entity's Skype profile
- phoneNumbers? BusinessCardPhoneNumber[] -
- linkedInLink? string - The URL to the entity's LinkedIn profile
- businessCardKey? string - A Karbon-generated unique identifier for the Business Card
- roleOrTitle? string - The business role or title of the contact this Business Cards belongs to
- organizationKey? string - A Karbon-generated key to indicate the organization this Business Card belongs to
- entityType? "Contact"|"Organization"|"ClientGroup" - The type of entity this Business Card belongs to
- addresses? BusinessCardAddress[] -
- entityKey? string - A Karbon-generated key to indicate the entity (Contact, Organization, or ClientGroup) this Business Card belongs to
- twitterLink? string - The URL to the entity's Twitter profile
- emailAddresses? string[] - The email addresses associated with this Business card
- facebookLink? string - The URL to the entity's Facebook profile
- isPrimaryCard? boolean - Set to true, if this business card is also the primary business card for this entity
karbon: BusinessCardAddress
Fields
- addressLines? string - Street Address
- zipCode? string - ZipCode / PostCode
- label? "Physical"|"Mailing"|"Legal"|"Home" - The tag to indicate the type of Address
- addressKey? string - A randomly generated GUID to indicate the address details
- city? string - City
- stateProvinceCounty? string - State / Province / County
- countryCode? string - Two letter Country Code
karbon: BusinessCardPhoneNumber
Fields
- phoneNumberKey? string - A randomly generated GUID to indicate the phone details
- number? string - The phone number of the entity
- label? "Work"|"Mobile"|"Office"|"Fax"|"Home"|"Other" - The tag to indicate the type of phone number
- countryCode? string - The phone number country code
karbon: BusinessCardRequest
A business card associated with a contact or organization
Fields
- webSites? string[] - The websites associated with this Business card
- skypeLink? string - The URL to the entity's Skype profile
- phoneNumbers? BusinessCardRequestPhoneNumber[] -
- linkedInLink? string - The URL to the entity's LinkedIn profile
- businessCardKey? string - A Karbon-generated unique identifier for the Business Card
- roleOrTitle? string? - The business role or title of the contact this Business Cards belongs to
- organizationKey? string? - Used on the Business Card for a Contact to specify the Organization that the Contact is related to. Will always be null for an Organization business card
- entityType? "Contact"|"Organization"|"ClientGroup" - The type of entity this Business Card belongs to
- addresses? BusinessCardRequestAddress[] -
- entityKey? string - A Karbon-generated key to indicate the entity (Contact, Organization, or ClientGroup) this Business Card belongs to
- twitterLink? string - The URL to the entity's Twitter profile
- emailAddresses? string[] - The email addresses associated with this Business card
- facebookLink? string - The URL to the entity's Facebook profile
- isPrimaryCard? boolean - Set to true, if this business card is also the primary business card for this entity
karbon: BusinessCardRequestAddress
Fields
- addressLines? string - Street Address
- zipCode? string - ZipCode / PostCode
- label? "Physical"|"Mailing"|"Legal"|"Home" - The tag to indicate the type of Address
- city? string - City
- stateProvinceCounty? string - State / Province / County
- countryCode? string - Two letter Country Code
karbon: BusinessCardRequestPhoneNumber
Fields
- number? string - The phone number of the entity
- label? "Work"|"Mobile"|"Office"|"Fax"|"Home"|"Other" - The tag to indicate the type of phone number
- countryCode? string - The phone number country code
karbon: BusinessCardResponse
A single Business Card, with the OData context and the entity it is connected to
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *BusinessCard
- webSites string[]
- skypeLink string
- phoneNumbers BusinessCardPhoneNumber[]
- linkedInLink string
- businessCardKey string
- roleOrTitle string
- organizationKey string
- entityType "Contact"|"Organization"|"ClientGroup"
- addresses BusinessCardAddress[]
- entityKey string
- twitterLink string
- emailAddresses string[]
- facebookLink string
- isPrimaryCard boolean
- anydata...
karbon: ClientAccessItem
Fields
- clientType? "Contact"|"Organization" - Whether the Client is an Organization or a Person
- clientKey? string - The unique key of the Client
- accessLevel? "Limited"|"FullAccess"? - The level of access this contact has when viewing the specified client in Karbon for Clients
karbon: ClientGroupAccountingDetails
Fields
- accountingDetails? string? - The accounting details associated with the Client Group. This property will be
null
karbon: ClientGroupBusinessCard
Fields
- businessCard? BusinessCard -
karbon: ClientGroupClientTeam
Fields
- clientTeam? ClientTeam -
karbon: ClientGroupDetails
A single Client Group, including its accounting details, business card and client team
Fields
- Fields Included from *ResponseCreateClientGroup
- contactType string
- lastModifiedDateTime string
- atOdataType string
- clientOwner string
- restrictionLevel "Public"|"Private"|"Hidden"
- clientGroupKey string
- userDefinedIdentifier string
- atOdataContext string
- primaryContact string
- entityDescription ResponseCreateClientGroupEntityDescription
- fullName string
- clientManager string
- members ClientGroupMember[]
- anydata...
- Fields Included from *ClientGroupAccountingDetails
- accountingDetails string|()
- anydata...
- Fields Included from *ClientGroupBusinessCard
- businessCard BusinessCard
- anydata...
- Fields Included from *ClientGroupClientTeam
- clientTeam ClientTeam
- anydata...
karbon: ClientGroupListItem
Fields
- lastModifiedDateTime string - The date and time at which the Client Group was most recently modified
- atOdataType? string - The information about Karbon Objects generating this response
- fullName string - The full name of the Client Group
- clientGroupKey string - A Karbon-generated unique identifier for the Client Group
- phoneNumber? string? - The phone number associated with the Client Group
- website? string? - The website associated with the Client Group
karbon: ClientGroupMember
Fields
- contactKey? string? - A Karbon-generated value that is used to identify the Contact
- organizationKey? string? - A Karbon-generated value that is used to identify the Organization
karbon: ClientTeamMember
Fields
- memberType? "User"|"Team" - The type of member assigned to the client team, can be either User or Team
- roleType? "ClientOwner"|"ClientManager"|"UserDefinedRole1"|"UserDefinedRole2"? - The specific role the user or team is assigned to, can be null if a member of the client team without a specific role
- memberKey? string - The unique key of the user or team assigned to the client team role
karbon: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
karbon: ContactListItem
Fields
- contactType? string - The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint
- address? string? - The Address of the Contact
- lastModifiedDateTime string - The date and time at which the Contact was most recently modified
- atOdataType? string - The information about Karbon Objects generating this response
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- userDefinedIdentifier? string - A unique key that you can use to identify this Contact
- roleOrTitle? string - The business role or title of the Contact
- salutation? string - The title to address the Contact
- emailAddress? string - The Email Address of the Contact
- fullName string - The full name of the Contact
- clientManager? string - The team member in your firm who manages the work for the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- contactKey string - A Karbon-generated unique identifier for the Contact
- phoneNumber? string? - The phone number associated with the Contact
- preferredName? string - The preferred name of the Contact
karbon: ContactsCardOrganization
A contact related to an Organization
Fields
- address? string? - The Address of the Contact
- lastModifiedDateTime? string - The date and time at which this Contact was last modified
- fullName? string - The full name of the Contact
- clientOwner? string? - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the Contact. You can only use the UserKey or the email address of an existing team member
- clientManager? string? - The team member in your firm who manages the work for Contact. You can only use the UserKey or the email address of an existing team member
- contactKey? string - A Karbon-generated value that is used to identify the Contact
- userDefinedIdentifier? string - A unique key that you can use to identify this Contact
- phoneNumber? anydata - The phone number associated with the Contact
- preferredName? string - The preferred name of the Contact
- roleOrTitle? string - The business role or title of the Contact
- salutation? string - The title to address the Contact
- emailAddress? string - The Email Address of the Contact
karbon: CreateClientGroup
A single Client Group
Fields
- contactType? string - The Contact Type for this Client Group. You can only use existing Contact Type
- entityDescription? ResponseCreateClientGroupEntityDescription -
- fullName string - The full name of the Client Group
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- clientManager? string - The team member in your firm who manages the work for the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Client Group. <ul><li>Public Client Groups can be managed by anyone in the firm</li> <li>Private Client Groups can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Contacts and the Work Items) related to such Client Groups are visible to anyone in the firm.</li> <li>Hidden Client Groups are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- userDefinedIdentifier? string - A unique key that you can use to identify this Client Group
- primaryContact? string - The main contact for a client with multiple contact details
- members? ClientGroupMember[] - The members of the Client Group
karbon: CreateClientGroupAccountingDetails
Fields
- accountingDetails? string? - The accounting details associated with the Client Group. This property will be
null
karbon: CreateClientGroupBusinessCard
Fields
- businessCard? BusinessCard -
karbon: CreateClientGroupClientTeam
Fields
- clientTeam? ClientTeam -
karbon: CreateClientGroupRequest
The details of the Client Group to create, including its accounting details, business card and client team
Fields
- Fields Included from *CreateClientGroup
- contactType string
- entityDescription ResponseCreateClientGroupEntityDescription
- fullName string
- clientOwner string
- clientManager string
- restrictionLevel "Public"|"Private"|"Hidden"
- userDefinedIdentifier string
- primaryContact string
- members ClientGroupMember[]
- anydata...
- Fields Included from *CreateClientGroupAccountingDetails
- accountingDetails string|()
- anydata...
- Fields Included from *CreateClientGroupBusinessCard
- businessCard BusinessCard
- anydata...
- Fields Included from *CreateClientGroupClientTeam
- clientTeam ClientTeam
- anydata...
karbon: CreateContact
A single Contact
Fields
- contactType? string - The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint
- firstName string - The first name of the Contact
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Contact. <ul><li>Public Contacts can be managed by anyone in the firm</li> <li>Private Contacts can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Contacts and the Work Items) related to such Contacts are visible to anyone in the firm.</li> <li>Hidden Contacts are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li> Setting `Private` requires the calling API application to have the `IncludePrivate` permission; setting `Hidden` requires `IncludeHidden`. `Public` is always allowed. Omitting this field on a PUT leaves the existing value unchanged
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the Contact. You can only use the UserKey or the email address of an existing team member
- userDefinedIdentifier? string - A unique key that you can use to identify this Contact
- middleName? string - The middle name of the Contact
- salutation? string - The title to address the Contact
- clientTeam? ClientTeam -
- suffix? string - The suffix of the Contact
- entityDescription? ResponseCreateContactEntityDescription -
- clientManager? string - The team member in your firm who manages the work for Contact. You can only use the UserKey or the email address of an existing team member
- businessCards? BusinessCardRequest[] -
- lastName string - The last name of the Contact
- preferredName? string - The preferred name of the Contact
- accountingDetail? DetailsOfAccounting -
karbon: CreatedWorkItem
The Work Item that was created, including its fee settings
Fields
- Fields Included from *CreatedWorkItemODataInfo
- Fields Included from *WorkItemWithFeeSettings
- clientType "Contact"|"Organization"|"ClientGroup"
- workTemplateTile string
- clientKey string
- relatedClientGroupKey string
- assigneeKey string
- deadlineDate string|()
- startDate string
- clientName string
- relatedClientGroupName string
- clientUserDefinedIdentifier string
- toDoPeriod string
- workStatus string
- workItemKey string
- dueDate string
- assigneeName string
- workType string
- secondaryStatus string
- clientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- completedDate string
- assigneeEmailAddress string
- estimatedBudget decimal
- FeeSettings WorkFeeSettingsFeeSettings
- anydata...
- Fields Included from *CreatedWorkItemDescription
karbon: CreatedWorkItemDescription
Fields
- description? string - A free form text field to add more information about the Work Item
- clientTaskRecipient? string - The details about the recipient of the Client Tasks related to this Work Item. This property will always return
null
karbon: CreatedWorkItemODataInfo
Fields
- atOdataType? string - The information about Karbon Objects generating this response
- atOdataContext? string - The information about Karbon controllers generating this response
karbon: CreateManualPaymentRequest
Fields
- InvoiceKey string - The unique key of the Invoice to pay
- PaymentMethod "Bank Transfer"|"Direct Debit"|"Credit Card Online"|"Credit Card Office"|"Check"|"Cash"|"Other" - The method used to pay the invoice
- PaymentDate string - The date the Payment is to be Recorded using an ISO 8601 datestamp
- TotalAmount float - The amount of the payment in the nominated currency, must be greater than 0 and equal or less than the outstanding due amount on the invoice.
- Reference? string - An optional reference to include with the payment.
karbon: CreateOrganization
A single Organization
Fields
- contactType? string - The Contact Type for this Organization. You can only use existing Contact Type
- entityDescription? CreateOrganizationEntityDescription -
- fullName string - The full name of the Organization
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- clientManager? string - The team member in your firm who manages the work for the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Organization. <ul><li>Public Organization can be managed by anyone in the firm</li> <li>Private Organization can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Organization and the Work Items) related to such Organization are visible to anyone in the firm.</li> <li>Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li> Setting `Private` requires the calling API application to have the `IncludePrivate` permission; setting `Hidden` requires `IncludeHidden`. `Public` is always allowed. Omitting this field on a PUT leaves the existing value unchanged
- userDefinedIdentifier? string - A unique key that you can use to identify this Organization
- businessCards? BusinessCardRequest[] -
- accountingDetail? DetailsOfAccounting -
- clientTeam? ClientTeam -
karbon: CreateOrganizationEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Organization
karbon: CreateOrganizationResponse
A single Organization
Fields
- contactType? string - The Contact Type for this Organization. You can only use existing Contact Type
- lastModifiedDateTime? string - The date and time at which this Contact was last modified
- atOdataType? string - The information about Karbon Objects generating this response
- entityDescription? CreateOrganizationResponseEntityDescription -
- fullName string - The full name of the Organization
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- clientManager? string - The team member in your firm who manages the work for the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Organization. <ul><li>Public Organization can be managed by anyone in the firm</li> <li>Private Organization can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Organization and the Work Items) related to such Organization are visible to anyone in the firm.</li> <li>Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- userDefinedIdentifier string - A unique key that you can use to identify this Organization
- atOdataContext string - The information about Karbon controllers generating this response
- accountingDetail? DetailsOfAccounting -
- organizationKey string - A Karbon-generated value that is used to identify the Organization
karbon: CreateOrganizationResponseEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Organization
karbon: CreateUserRequest
Fields
- emailAddress string - The email address of the User
- name string - The name of the User
karbon: CreateWebhookSubscriptionRequest
Fields
- batchSize? int - The number of notifications to accumulate before delivering them together as a JSON array in a single
POST. A hard cap — once a batch reaches this size, further events start a new batch. Omit, or set to1, to keep the existing payload format of one notification object perPOST. Applies to both single-type and multi-type subscriptions
- batchMaxDelaySeconds? int - An additional delay, in seconds, added on top of the standard 60-second dispatch window before a batch is sent.
0means no extra delay beyond that window. Only applies whenBatchSizeis set to more than1
- signingKey? anydata - An optional key that will be used to sign webhook payloads, may contain letters, numbers, dashes or underscores
- webhookType? "Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary" - The type of Karbon entity which the Webhook Subscription is associated with. To receive ClientGroup, Contact and Organization updates, pass WebhookType as
Contact. To receive Custom Field value updates, pass WebhookType asCustomField. To receive WorkItem updates, pass WebhookType asWork. To receive Note and NoteComment updates, pass WebhookType asNote. To receive an update when a User has accepted an invite to Karbon, pass WebhookType asUser. To receive an update when an Invoice changes status, pass WebhookType asInvoice. To receive an update when an EstimateSummary is updated, pass WebhookType asEstimateSummary. Integration partners using the Integration Task feature can useIntegrationTaskas the webhook subscription type to receive a notification when an integration task is added to a Work Item or a new Work Item is created from a Work Template that contains one or more Integraition Tasks. Mutually exclusive withWebhookTypes
- targetUrl? string - The URL to your server that is waiting to receive information about the
WebhookTypefrom Karbon
- webhookTypes? ("Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary")[] - Creates a multi-type subscription covering this set of resource types under one subscription with one
TargetUrl, addressed afterwards at/v3/WebhookSubscriptions/Multi. Mutually exclusive withWebhookType— providing both returns a 400. There can only be one multi-type subscription per API application
karbon: CreateWorkItemRequest
A single work item
Fields
- Fields Included from *WorkItemUpdate
- clientType "Contact"|"Organization"|"ClientGroup"
- description string
- workType string
- secondaryStatus string
- clientKey string
- relatedClientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- deadlineDate string|()
- startDate string
- assigneeEmailAddress string
- workStatus string
- clientTaskRecipient WorkItemUpdateClientTaskRecipient
- dueDate string
- estimatedBudget decimal
- anydata...
- Fields Included from *WorkFeeSettings
- FeeSettings WorkFeeSettingsFeeSettings
- anydata...
- Fields Included from *WorkItemUserRoleAssignments
- UserRoleAssignments WorkItemUserRoleAssignment[]
- anydata...
karbon: CustomFieldDefinition
The structure that defines a Custom Field in Karbon
Fields
- 'type? "Text"|"Number"|"Date"|"Boolean"|"Colleague"|"ListSingleSelect"|"ListMultipleSelect" -
- isVisibleToOrganizations? boolean -
- listOptions? CustomFieldDefinitionListOptionsItemsString[] -
- isVisibleToContacts? boolean -
- name? string -
karbon: CustomFieldDefinitionItem
Fields
- 'key? string -
- Fields Included from *CustomFieldDefinition
- type "Text"|"Number"|"Date"|"Boolean"|"Colleague"|"ListSingleSelect"|"ListMultipleSelect"
- isVisibleToOrganizations boolean
- listOptions CustomFieldDefinitionListOptionsItemsString[]
- isVisibleToContacts boolean
- name string
- anydata...
karbon: CustomFieldDefinitions
A list of the available custom fields in Karbon
Fields
- atOdataCount? decimal -
- atOdataContext? string -
- value? CustomFieldDefinitionItem[] -
karbon: CustomFieldValue
A collection of Custom Fields
Fields
- 'type? "Text"|"Number"|"Date"|"Boolean"|"Colleague"|"ListSingleSelect"|"ListMultipleSelect" -
- value? CustomFieldValueValueItemsString[] -
- 'key? string -
- name? string -
karbon: CustomFieldValues
The set custom fields for a contact or organization and the associated values and options
Fields
- entityKey? string -
- customFieldValues? CustomFieldValue[] -
karbon: DetailsOfAccounting
The details specific to the Accounting firm related to this entity
Fields
- sells? "Services"|"Products"|"Products and Services"|"Other"? - The item that is primarily supplied by the company
- bank? string[] - A user definable list of banks the client uses
- expenses? string[] - A user definable list of expense management services the client uses
- accounting? string[] - A user definable list of accounting tools and services the client uses
- sex? "M"|"F"? - The gender of the contact (if a person)
- taxCountryCode? "US"|"AU"|"UK"|"NZ"|"CA"|"ZA"|"HK"|"FR"|"SG"|"IE"|"SE"|"FI"|"DK"|"NO"|"IN"|"CH"? - The code of the country where the contact pays their tax
- benefits? string[] - A user definable list of benefits services the client uses
- salutation? "Mr"|"Mrs"|"Ms"|"Miss"|"Dr"|"Prof"|"Rev"? - The title of the contact (if a person)
- revenueModel? "Advertising"|"Commission"|"E-Commerce"|"Fee for Service"|"Licensing"|"Markup"|"Production"|"Subscription"? - The revenue model of the business or organization
- contactPermaKey? string? - A Karbon-generated key that is used to identify the Contact (if a person)
- payroll? string[] - A user definable list of payroll services the client uses
- gstBasis? "Cash"|"Accruals"|"None"|"Close"? - The method of accounting for GST/BAS
- incomeTaxInstallmentPeriod? "Monthly"|"Quarterly"|"Yearly"? - The income tax installment period
- legalFirm? DetailsOfAccountingLegalFirm? -
- paysTax? boolean? - Set to true, if the contact has to pay tax
- isVATRegistered? boolean? - Set to true if the business or organization is registered for VAT
- prepareGST? boolean? - <>
- dateSignedEngagement? string? -
- registrationNumbers? AccountingRegistrationNumber[] - The registration numbers associated with the contact
- notes? AccountingNote[] -
- legalName? string? - The legal name of the contact
- fileManagement? string[] - A user definable list of file management services the client uses
- provisionalTaxBasic? string? - <>
- provisionalTaxRatio? string? - <>
- taxProvider? DetailsOfAccountingTaxProvider? -
- salesTaxBasis? "Cash"|"Accruals"|"None"|"Close"? - The tax method
- billPay? string[] - A user definable list of bill payment services the client uses
- deathDate? string? - The day at which the contact (if a person) died
- financialYearEndMonth? Signed32? - The month in which the fiscal year ends for the contact. Note that this is a 0 index value, so January is 0 and December is 11
- entityType? "Corporation"|"Club or Society"|"Estate or Trust"|"Exempt Organization"|"Partnership"|"Private Foundation"|"S Corporation"|"Person"|"Sole Proprietor"|"Limited Liability"|"Charitable Incorporated Organisation"|"Company Limited by Guarantee"|"Community Interest Company"|"Limited Liability Partnership"|"Local Authority"|"Non Departmental Public Body"|"Pension Scheme"|"Royal Charter"|"Unincorporated Association"|"Other/None"? - The entity type of the contact (if a business or an organization)
- salesTaxPeriod? string? - The tax period
- organizationValuation? decimal? - The present value of the company
- gstPeriod? string? - The GST period
- incorporationState? string? - The state in which the contact (if a business or an organization) was incorporated
- financialYearEndDay? Signed32? - The day of month in which the fiscal year ends for the contact
- organizationPermaKey? string? - A Karbon-generated key that is used to identify the Contact (if a business or an organization)
- lineOfBusiness? string? - The industry this contact is associated with
- tradingName? string? - The trading name of the contact (if a business or an organization)
- baseCurrency? string? - The 3-letter code, denoting the currency of annual revenue
- revenue? string[] - A user definable list of revenue management services the client uses
- annualRevenue? decimal? - The total annual revenue generated by the contact
- birthDate? string? - The day at which the contact (if a person) was born
- incorporationDate? string? - The date at which the contact (if a business or an organization) was incorporated
karbon: DetailsOfAccountingLegalFirm
The legal firm(s) that represent the client, these can be strings or references to Karbon organizations
Fields
- name? string - The name of the legal firm that represents the client
- organizationKey? string? - The Organization key of the Karbon organization client record
karbon: DetailsOfAccountingTaxProvider
The provider of tax services to the client, these can be strings or references to Karbon organizations
Fields
- name? string - The name of the tax provider
- organizationKey? string? - The optional Organization key of the Tax Provider client record in Karbon
karbon: DownloadFileQueries
Represents the Queries record for the operation: downloadFile
Fields
- token string - A Karbon-generated JWT token that is used to identify the File
karbon: EstimateSummary
Fields
- roleKey? string - A Karbon-generated unique identifier for the user's role
- roleName? string - The Role of the user
- actualMinutes? int - The actual time (in minutes) spent on the task
- userKey? string - A Karbon-generated unique identifier for the Karbon user
- estimateMinutes? int - The total estimated time (in minutes) for the task to be completed
- estimateSummaryKey? string - A randomly generated GUID. Changing HourlyRate on a PATCH can reissue this key — use the OData-EntityId response header to get the current one
- taskTypeKey? string - A Karbon-generated unique identifier for the task
- taskTypeName? string - The name of the task
- hourlyRate? decimal - The hourly rate of the user
- estimateAmount? decimal - The estimated cost of the task, calculated from the estimated time at the user's hourly rate
karbon: EstimateSummaryList
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- value? EstimateSummaryListItem[] -
karbon: EstimateSummaryListItem
Fields
- roleKey? string - A Karbon-generated unique identifier for the user's role
- roleName? string - The Role of the user
- actualMinutes? int - The actual time (in minutes) spent on the task
- userKey? string - A Karbon-generated unique identifier for the Karbon user
- estimateMinutes? int - The total estimated time (in minutes) for the task to be completed
- estimateSummaryKey? string - A randomly generated GUID
- taskTypeKey? string - A Karbon-generated unique identifier for the task
- taskTypeName? string - The name of the task
- hourlyRate? decimal - The hourly rate of the user
- estimateAmount? decimal - The estimated cost of the task, calculated from the estimated time at the user's hourly rate
karbon: ExpenseRequest
A single Expense
Fields
- billableValue decimal - The portion of the Expense that is billable to the client. Cannot be negative. Use 0 for an Expense that will not be billed on
- timeline ExpenseRequestTimeline -
- description string - A description of the Expense. Limited to 250 characters
- expenseDate string - The date the Expense was incurred
- value decimal - The cost of the Expense. Cannot be negative
karbon: ExpenseRequestTimeline
The entity the Expense is recorded against
Fields
- entityType? "WorkItem"|"Contact"|"Organization" - The type of entity this Expense will be linked to
- entityKey? string - A Karbon-generated value to indicate the entity
karbon: ExpenseResponse
A single Expense
Fields
- expenseKey? string - The unique identifier of the Expense
- Fields Included from *ExpenseRequest
- billableValue decimal
- timeline ExpenseRequestTimeline
- description string
- expenseDate string
- value decimal
- anydata...
karbon: FileList
A collection of files associated with an entity in Karbon
Fields
- entityType? "WorkItem"|"Contact"|"Organization" - The type of entity the file list is associated with
- entityKey? string - The unique key of the entity the list of files is associated with
- totalCount? int - The number of files matching the
$filterexpression, before$skipand$topare applied
- attachments? FileListItem[] - An array of Files including a name, mimetype, size, creation timestamp and download url
karbon: FileListItem
A single File
Fields
- isArchived? boolean - Whether the file has been archived
- isShared? boolean - Whether the client can see the file. Files uploaded by a client, or attached to a Client Task, External Comment, Approval or eSignature, are always shared. Read-only
- fileName? string - The name of the file
- dateCreated? string - The timestamp of when the file was created
- fileContextKey? string - The unique key of the file
- 'source? "WorkItem"|"Contact"|"Organization" - The type of entity the file was uploaded against
- mimeType? string - The mimetype of the uploaded file
- fileSize? int - The size of the file in bytes
- downloadUrl? string - The API path than can be called to download the file
karbon: GetClientGroup
A list of Client Groups
Fields
- atOdataNextLink? string - The link to next set of Client Groups. @odata.nextLink field will only appear if you have more than 100 Client Groups
- atOdataCount int - The total number of Client Groups that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value ClientGroupListItem[] -
karbon: GetClientGroupByIdentifierQueries
Represents the Queries record for the operation: getClientGroupByIdentifier
Fields
- expand? "BusinessCard" - When this parameter is combined with the URI, this endpoint will also return the Business Card of the Client Group
karbon: GetClientGroupQueries
Represents the Queries record for the operation: getClientGroup
Fields
- expand? string - When this parameter is specified in the query string this endpoint will also return the Business Card and/or Client Team of the Client Group
karbon: GetComment
A comment on a Work Item, Note or Contact
Fields
- \@odata\.context? string - The information about Karbon controllers generating this response.
- CommentKey? string - A Karbon-generated unique identifier for the comment
- CommentTypeKey? string - A Karbon-generated value that is used to identify the Karbon entity (e.g., Work Item, Notes, Contacts) associated with the comment.
- CommentBody string - The comment left behind by a Karbon user.
- CreatedDate string - The date and time at which the comment was created in Karbon. This value is automatically generated by Karbon. The datetime format is UTC.
- AuthorKey string - A random value that indicates the email address of the Karbon user who created the comment.
karbon: GetContactByIdentifierQueries
Represents the Queries record for the operation: getContactByIdentifier
Fields
- expand? "BusinessCards"|"ServiceTypes" - When this parameter is combined with the URI, this endpoint will also return the Business Cards or Service Types of the Contact
karbon: GetContactQueries
Represents the Queries record for the operation: getContact
Fields
- expand? "BusinessCards"|"ClientTeam"|"ClientAccess"|"ServiceTypes" - When this parameter is combined with the URI, this endpoint will also return one or more of the following: Business Cards for the Contact, the Client Team assigned to the Contact, a list of other Contacts that can access this Contact in Karbon for Clients, or the Service Types assigned to the Contact
karbon: GetContacts
A list of Contacts
Fields
- atOdataNextLink? string - The link to next set of Contacts. @odata.nextLink field will only appear if you have more than 100 Contacts
- atOdataCount int - The total number of Contacts that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value ContactListItem[] -
karbon: GetIndividualTimeEntries
A collection of individual time entries
Fields
- atOdataNextLink? string - The link to the next set of individual time entries. @odata.nextLink field will only appear if you have more than 1000 individual time entries
- atOdataCount? int - The total number of individual time entries that satisfy the query criteria. Only present when
$count=trueis specified
- atOdataContext string - The information about Karbon controllers generating this response
- value GetIndividualTimeEntry[] -
karbon: GetIndividualTimeEntry
A single individual (non-aggregated) time entry
Fields
- clientType? "Contact"|"Organization"|"ClientGroup" - The type of Client
- description? string - Free-form text providing more information about the time entry
- feeType? string - The fee type associated with this time entry
- timesheetKey string - A Karbon-generated key used to identify the Timesheet this entry belongs to
- clientKey? string - A Karbon-generated key used to identify the Client this time entry is related to
- userKey string - A Karbon-generated key used to identify the user who logged this time entry
- modifiedDate? string - The date and time when this time entry was last modified
- individualTimeEntryKey string - A Karbon-generated GUID key used to uniquely identify the individual time entry (32-character hex string, no hyphens)
- date string - The date on which the time was logged
- minutes int - The total time (in minutes) spent on the task
- hourlyRate? decimal - The hourly rate of the user who worked on the task
- totalCost? decimal - The total cost of this time entry (Minutes / 60 × HourlyRate)
- entityKey string - A Karbon-generated key used to identify the entity this time entry is related to
- roleName? string - The role of the user for whom the time entry was created
- billedStatus? "Unbilled"|"Draft"|"InterimBilled"|"Billed" - An indicator that represents whether the time entry has been or is in the process of being billed
- workItemKey? string - A Karbon-generated key used to identify the Work Item this time entry is related to
- createdDate? string - The date and time when this time entry was created
- taskTypeName? string - The type of task performed by the user
- taskTypeIsBillable? boolean - Indicates whether the task type is configured as billable. A value of false means the time entry will not be billed regardless of the entity's billing type or the entry's BilledStatus
karbon: GetInvoiceQueries
Represents the Queries record for the operation: getInvoice
Fields
- expand? "LineItems"|"Payments"|"Data"|"LineItems,Data"|"LineItems,Payments"|"LineItems,Payments,Data"|"Payments,Data" - Include additional invoice properties, such as lineitems, payments or invoice data
karbon: GetOrganizationByIdentifierQueries
Represents the Queries record for the operation: getOrganizationByIdentifier
Fields
- expand? "BusinessCards"|"ServiceTypes" - When this parameter is combined with the URI, this endpoint will also return the Business Cards or Service Types of the Contact Organization
karbon: GetOrganizationQueries
Represents the Queries record for the operation: getOrganization
Fields
- expand? string - When this parameter is combined with the URI, this endpoint will also return Business Cards, Client Team, Contacts and/or Service Types associated with the Organization. Multiple properties can be returned by specifying a comma separated list
karbon: GetOrganizations
A list of Organizations
Fields
- atOdataNextLink? string - The link to next set of Organizations. @odata.nextLink field will only appear if you have more than 100 Organizations
- atOdataCount int - The total number of Organizations that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value OrganizationListItem[] -
karbon: GetRoles
The API response containing a list of Roles in Karbon
Fields
- atOdataNextLink? string -
- atOdataCount? int -
- atOdataContext? string -
- value? Role[] -
karbon: GetSingleTimeSheet
A single TimeSheet with TimeEntries
Fields
- startDate string - The start date for the TimeSheet
- status "Approved"|"Declined"|"Draft"|"Submitted" - The approval status of the Timesheet
- workItemKeys? string[] - An array of WorkItem keys
- timesheetKey string - A Karbon-generated unique identifier for the Timesheet
- userKey string - A Karbon-generated key used to identify the user, this Timesheet belongs to
- timeEntries? TimesheetTimeEntry[] - An array of Time entries
- endDate string - The end date for the TimeSheet
karbon: GetSingleUser
The unique id, name and email address for a single User
Fields
- id string - A Karbon-generated key used to identify the User
- emailAddress string - The email address of the User
- name string - The name of the User
karbon: GetSingleWorkTemplate
A single Work Template
Fields
- hasScheduledClientTaskGroups boolean - This property is set to true, if the Work Template has scheduled Client Tasks
- estimatedTime? string - The estimated time required to complete the Work Items generated using this Work Template. This property value will be
null
- description? string - A free text field to add more information about the Work Template
- title? string - The title of the Work Template
- workTemplateKey string - A Karbon-generated unique identifier for the Work Template
- actorRoles? WorkTemplateActorRole[] - The user roles who are required to action the Work Items created using this Work Template
- draftHasChanges boolean - This property is set to true, if the Work Template has unpublished changes
- workTypeKey string - A Karbon-generated unique identifier to denote the Work Type
- numberOfWorkItemsCreated decimal - The number of Work Items created using this Work Template
- publishedDate string - The date at which this Work Template was published
- estimatedBudget? string? - The estimated budget for the Work Items generated using this Work Template. This property value will be
null
- dateLastWorkItemCreated string - The most recent date at which a Work Item was created using this Work Template
- dateModified string - The most recent date at which this Work Template was modified
karbon: GetTeams
The API response containing a list of Teams in Karbon
Fields
- atOdataNextLink? string -
- atOdataCount? int -
- atOdataContext? string -
- value? Team[] -
karbon: GetTenantSettings
A collection of customer specific Contact and Work settings
Fields
- workTypes? SettingWorkType[] -
- contactTypes? SettingContactType[] -
- tenantKey? string - The unique key specific to the customer's Karbon account
- workStatuses? SettingWorkStatus[] -
- serviceTypes? SettingServiceType[] -
- clientAccessActivated? boolean - Indicates whether the tenant has activated Karbon for Clients (K4C)
karbon: GetTimesheetQueries
Represents the Queries record for the operation: getTimesheet
Fields
- expand? "TimeEntries" - When this parameter is combined with the URI, this endpoint will also return the Time Entries associated with the Timesheets
karbon: GetTimeSheets
A collection of TimeSheets
Fields
- atOdataNextLink? string - The link to next set of Timesheets. @odata.nextLink field will only appear if you have more than 100 Timesheets
- atOdataCount int - The total number of Timesheets that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value GetSingleTimeSheet[] -
karbon: GetUserById
The details for a single User
Fields
- capacityMinutesPerWeek? int - The number of billable minutes allocated to the user per week
- atOdataType? string - The information about Karbon data type in this response
- permissions? string[] - A list of the permissions allocated to the User
- teams? UserTeamItem[] - A list of the teams the User is member of
- roles? UserRoleItem[] -
- atOdataContext? string - The information about Karbon controllers generating this response
- id? string - The unique Id of the User, this should match the key used in the URL
- billableRate? decimal - The default hourly rate in at which the user's work is billed at. The currency for
BillableRateis based on the firm's currency and region found in Karbon under Settings > Account Settings
- emailAddress? string - The email address of the User
- name? string - The name of the User
karbon: GetUsers
A collection of Users
Fields
- atOdataNextLink? string - The link to next set of Users. @odata.nextLink field will only appear if you have more than 100 Users
- atOdataCount int - The total number of Users that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value GetSingleUser[] -
karbon: GetWebhookSubscriptions
The details of a specific Webhook Subscription
Fields
- batchSize? int - The number of notifications accumulated before delivery as a single batch
- batchMaxDelaySeconds? int - The additional delay, in seconds, applied on top of the standard 60-second dispatch window before a batch is sent
- webhookType? "Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary"|"Multi"? - The type of Karbon entity, which the Webhook Subscription is associated with.
Multion the response to thePOSTthat created a multi-type subscription;nullwhen that same subscription is retrieved afterwards viaGET— useWebhookTypesinstead
- atOdataContext? string - The information about Karbon controllers generating this response
- targetUrl? string - The URL to your server that is waiting to receive information about the
WebhookTypefrom Karbon
- webhookTypes? string[] - Present on a multi-type subscription. The set of resource types this subscription receives notifications for
karbon: GetWorkItems
A collection of work items
Fields
- atOdataNextLink? string - The link to next set of Work Items. @odata.nextLink field will only appear if you have more than 100 Work Items
- atOdataCount int - The total number of Work Items that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value WorkItemListItem[] -
karbon: GetWorkSchedule
A single Work Schedule
Fields
- recurrenceFrequency "Day"|"Week"|"SemiMonth"|"Fortnight"|"Month"|"Quarter"|"Year"|"Custom" - The denominator of time period at which this Work Schedule should repeat. Once set, the value of this property can not be changed
- customFrequencyUnits? "Days"|"Weeks"|"Months"|"Years"? - The unit of time at which this Work Schedule should repeat. Once set, the value of this property can not be changed.
This property is only applicable if
RecurrenceFrequencyis set toCustom
- initializeBeforeStartDateUnits? "Days"|"Weeks"|"Months"|"Years" - You can automatically create a Work Item before its Start date. Use this property to set the unit of delay between Start date and Work Item creation date
- workItemTitleDefinition string - Use this property to define the format of the Work Item title. Karbon offers a series of object that you can use to construct Work Item Title. For more information, see Technical Guide to Work Item Title Definition
- clientType "Contact"|"Organization"|"ClientGroup" - The type of the Client
- initializeTasksBeforeStartDateMultiple Signed32 - You can automatically create budget and tasks for a Work Item before its Start date. Use this property to set the multiple of delay unit between Start date and task creation date
- initializeTasksBeforeStartDateUnits "Days"|"Weeks"|"Months"|"Years" - You can automatically create budget and tasks for a Work Item before its Start date. Use this property to set the unit of delay between Start date and task creation date
- clientKey string - A Karbon-generated value used to identify the Client for whom the Work Item is prepared
- assigneeUserKey string - A Karbon-generated unique identifier to indicate the user, whom the Work Item has been assigned to
- scheduleStartDate string - The date at which this Work Schedule should start running
- scheduleEndDate? string - The date at which this Work Schedule should stop running
To set the Work Schedule to run forever, set the value of this property to
0001-01-01
- workItemTitleDisplayText? string - The title of the related Work Item
- createdFromWorkItemKey string - The key of the Work Item, which the Work Schedule will be assigned to. This value will be
null
- frequencyDescription? string - A description of the Frequency
- preventStartEndOnWeekend boolean - If the value of this property is set to
true, the Work Item will not start on Weekends
- scheduleDueDateDays? Signed32 - The value of the count for the Due Date
This property is not applicable if
ScheduleDueDateMethodis set toLastDayOfMonthorNoDueDate. Example of usage: <table> <th>ScheduleDueDateMethod</th> <th>ScheduleDueDateDays</th> <th>Read Due Date as</th> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>7 days after start date</td> </tr> <tr> <td>DayOfMonth</td> <td>7</td> <td>7th day of the current month</td> </tr> <tr> <td>LastDayOfMonth</td> <td>N/A</td> <td>Last day of the current month</td> </tr> <tr> <td>DayOfNextMonth</td> <td>7</td> <td>7th day of the next month</td> </tr> <tr> <td>NoDueDate</td> <td>N/A</td> <td>Work has no due date</td> </tr> </table>
- atOdataContext string - The information about Karbon controllers generating this response
- workScheduleKey string - A Karbon-generated unique identifier for the Work Schedule
- customFrequencyMultiple Signed32 - The multiple of time unit at which this Work Schedule should repeat. This property is not applicable if
RecurrenceFrequencyis set toSemiMonth,Fortnight, orQuarter
- scheduleDeadlineDateMethod? "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDeadlineDate" - The method that should be used to count the Deadline Date for the Work Item.
Companies House-driven and filing-date-driven deadline methods are not available through the API; setting
ScheduleDeadlineDateMethodtoCompaniesHouseAccountsDueDate,CompaniesHouseConfirmationStatementDueDateorOnFilingDatereturns a400
- workItemDescription? string - A free form text field for more information about the Work Item
- scheduleDueDateMonthMultiple? Signed32 - The value to denote the number of the months, if the due date is after 2 months.
This property is only applicable if
ScheduleDueDateMethodis set toDayOfSubsequentMonth. Example of usage: <table> <thead> <th>ScheduleDueDateMethod</th> <th>ScheduleDueDateDays</th> <th>ScheduleDueDateMonthMultiple</th> <th>Read Due Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>3</td> <td>7th day of the 3rd month after start date</td> </tr> </tbody> </table>
- scheduleDeadlineDateDays? Signed32 - The value of the count for the Deadline Date
This property is not applicable if
ScheduleDeadlineDateMethodis set toLastDayOfMonthorNoDeadlineDate. Example of usage: <table> <th>ScheduleDeadlineDateMethod</th> <th>ScheduleDeadlineDateDays</th> <th>Read Deadline Date as</th> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>7 days after start date</td> </tr> <tr> <td>DayOfMonth</td> <td>7</td> <td>7th day of the current month</td> </tr> <tr> <td>LastDayOfMonth</td> <td>N/A</td> <td>Last day of the current month</td> </tr> <tr> <td>DayOfNextMonth</td> <td>7</td> <td>7th day of the next month</td> </tr> <tr> <td>NoDeadlineDate</td> <td>N/A</td> <td>Work has no deadline date</td> </tr> </table>
- initializeBeforeStartDateMultiple? Signed32 - You can automatically create a Work Item before its Start date. Use this property to set the multiple of delay unit between Start date and Work Item creation date
- scheduleDueDateMethod "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDueDate" - The method that should be used to count the Due Date for the Work Item
- scheduleDeadlineDateMonthMultiple? Signed32 - The value to denote the number of the months, if the deadline date is after 2 months.
This property is only applicable if
ScheduleDeadlineDateMethodis set toDayOfSubsequentMonth. Example of usage: <table> <thead> <th>ScheduleDeadlineDateMethod</th> <th>ScheduleDeadlineDateDays</th> <th>ScheduleDeadlineDateMonthMultiple</th> <th>Read Deadline Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>3</td> <td>7th day of the 3rd month after start date</td> </tr> </tbody> </table>
karbon: GetWorkTemplates
A collection of Work Templates
Fields
- atOdataNextLink? string - The link to next set of Work Templates. @odata.nextLink field will only appear if you have more than 10 Work Templates
- atOdataCount int - The total number of Work Templates that satisfy the query criteria
- atOdataContext string - The information about Karbon controllers generating this response
- value GetSingleWorkTemplate[] -
karbon: IndividualTimeEntryResponse
A single individual time entry, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *GetIndividualTimeEntry
- clientType "Contact"|"Organization"|"ClientGroup"
- description string
- feeType string
- timesheetKey string
- clientKey string
- userKey string
- modifiedDate string
- individualTimeEntryKey string
- date string
- minutes int
- hourlyRate decimal
- totalCost decimal
- entityKey string
- roleName string
- billedStatus "Unbilled"|"Draft"|"InterimBilled"|"Billed"
- workItemKey string
- createdDate string
- taskTypeName string
- taskTypeIsBillable boolean
- anydata...
karbon: IntegrationTask
A single Integration Task
Fields
- Fields Included from *IntegrationTaskReadOnly
- Fields Included from *IntegrationTaskWriteable
- taskName string
- taskPrimaryLinkLabel anydata
- taskDueDate string
- taskPrimaryLinkUrl anydata
- taskSecondaryLinkLabel anydata
- taskSecondaryLinkUrl anydata
- taskStatus string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- taskData IntegrationTaskData[]
- anydata...
karbon: IntegrationTaskData
Optional integration task data key/value pairs
Fields
- value? string -
- 'key? string -
karbon: IntegrationTaskDefinition
A list of Integration Task Definitions
Fields
- taskName? string - The name of the specific Integration Task Definition
- taskPrimaryLinkLabel? anydata - The optional default label for the primary link URL of the specific Integration Task Definition
- taskPrimaryLinkUrl? anydata - The optional default primary link URL of the specific Integration Task Definition
- allowedTaskUrlHosts? string[] - The list of allowed hostnames that the primary and secondary link URLs must match
- taskSecondaryLinkLabel? anydata - The optional default label for the primary link URL of the specific Integration Task Definition
- taskSecondaryLinkUrl? anydata - The optional default primary link URL of the specific Integration Task Definition
- taskDefinitionKey? string - The unique ID of the specific Integration Task Definition
- locales? string[] - The list of locales and languages the integration task definition is suitable for use with, useful when different definitions are required for different languages or locales
karbon: IntegrationTaskDefinitions
A list of Integration Task Definitions
Fields
- values? IntegrationTaskDefinition[] -
- atOdataContext? string -
karbon: IntegrationTaskReadOnly
The read-only properties of an Integration Task
Fields
- locale? string - The list of locales and languages the integration task definition is suitable for use with, useful when different definitions are required for different languages or locales
- workItemClientKey? string -
- workType? string -
- createdAt? string -
- workItemKey? string -
- taskDefinitionKey? string - The unique ID of the integration task definition
- taskKey? string - The unique key of the specific Integration Task Definition for the associated Karbon account
karbon: IntegrationTasks
A list of Integration Tasks
Fields
- atOdataCount? decimal -
- atOdataContext? string -
- value? IntegrationTask[] -
karbon: IntegrationTaskWriteable
The writable properties of an Integration Task
Fields
- taskName? string - The name of the specific Integration Task Definition
- taskPrimaryLinkLabel? anydata - The optional default label for the primary link URL of the specific Integration Task Definition
- taskDueDate? string -
- taskPrimaryLinkUrl? anydata - The optional default primary link URL of the specific Integration Task Definition
- taskSecondaryLinkLabel? anydata - The optional default label for the secondary link URL of the specific Integration Task Definition
- taskSecondaryLinkUrl? anydata - The optional default label for the secondary link URL of the specific Integration Task Definition
- taskStatus? string -
- primaryStatus? "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed" -
- taskData? IntegrationTaskData[] - Key/value metadata for the task. The combined serialized content must not exceed 4000 characters
karbon: InvoiceList
Fields
- \@odata\.context? string - The information about Karbon controllers generating this response.
- \@odata\.count? int - The total number of results
- values? BillingInvoice[] -
karbon: InvoiceResponse
A single Invoice, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *BillingInvoiceWithPayment
- invoiceTaxTotal decimal
- currencyCode string
- invoiceTotal decimal
- invoiceKey string
- invoiceSubTotal decimal
- invoiceNumber string
- invoiceDate string
- paymentInstructions string|()
- updatedAt string
- invoiceStatus "Approved"|"AwaitingPayment"|"Paid"|"Exported"|"Voided"
- totalAmountDue decimal
- paymentDueDate string
- Client BillingClientClient|()
- taxLineItems BillingTaxLineItem[]
- lineItems BillingInvoiceLineItem[]
- payments BillingInvoicePayment[]
- data BillingInvoiceDataItem[]
- anydata...
karbon: ListClientGroupsQueries
Represents the Queries record for the operation: listClientGroups
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Client Groups that satisfy the
$filterexpression
- orderby string(default "ClientGroupKey") - When this parameter is combined with the URI, this endpoint will return a list of Client Groups, sorted by the available properties
karbon: ListContactsQueries
Represents the Queries record for the operation: listContacts
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Contacts that satisfy the
$filterexpression
- orderby? "FullName"|"FullName desc"|"LastModifiedDateTime"|"LastModifiedDateTime desc" - When this parameter is combined with the URI, this endpoint will return a list of Contacts, sorted by the available properties
karbon: ListFilesQueries
Represents the Queries record for the operation: listFiles
Fields
- entityKey string - The unique key to list files for
- skip? int - Skip the first n files after filtering and sorting
- top? int - Limit the number of files returned, up to 100
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the files that satisfy the
$filterexpression. SupportsIsArchived,IsShared,SourceandMimeTypewith theeqoperator, combined withand
- orderby "DateCreated"|"DateCreated desc" (default "DateCreated desc") - Sort the files by upload date. Newest first when omitted
karbon: ListIndividualTimeEntriesQueries
Represents the Queries record for the operation: listIndividualTimeEntries
Fields
- skip? int - Skip the first n items. There is no upper limit on this value
- top? int - Limit the number of items returned. Maximum value is 1000
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the individual time entries that satisfy the
$filterexpression
- orderby "Date"|"Date desc" (default "Date") - Sort the results by Date
- count? boolean - Default is
false(falseis recommended). When set totrue, the response will include the total count of matching entries in@odata.count
karbon: ListIntegrationTasksQueries
Represents the Queries record for the operation: listIntegrationTasks
Fields
- filter? string - The a filter applied to the list of integration tasks before they are returned
- orderby? string - Order responses by invoice date
karbon: ListInvoicesQueries
Represents the Queries record for the operation: listInvoices
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Invoices that satisfy the
$filterexpression. TheInvoiceStatusproperty supports theeqoperator
- orderby? string - Alter the sort order of the invoice list
karbon: ListOrganizationsQueries
Represents the Queries record for the operation: listOrganizations
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Organizations that satisfy the
$filterexpression
- orderby? "FullName"|"FullName desc"|"LastModifiedDateTime"|"LastModifiedDateTime desc" - When this parameter is combined with the URI, this endpoint will return a list of Organizations, sorted by the available properties
karbon: ListPaymentsQueries
Represents the Queries record for the operation: listPayments
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
karbon: ListRolesQueries
Represents the Queries record for the operation: listRoles
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Roles that satisfy the
$filterexpression. OnlyNamewith theeqoperator is supported
karbon: ListTeamsQueries
Represents the Queries record for the operation: listTeams
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Teams that satisfy the
$filterexpression. OnlyNamewith theeqoperator is supported
karbon: ListTimesheetsQueries
Represents the Queries record for the operation: listTimesheets
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Timesheets that satisfy the
$filterexpression
- orderby? "StartDate"|"StartDate desc"|"EndDate"|"EndDate desc" - When this parameter is combined with the URI, this endpoint will return a list of Timesheets, sorted by the available properties
- expand? "TimeEntries" - When this parameter is combined with the URI, this endpoint will also return the Time Entries associated with the Timesheets
karbon: ListUsersQueries
Represents the Queries record for the operation: listUsers
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Users that satisfy the
$filterexpression
karbon: ListWorkItemsQueries
Represents the Queries record for the operation: listWorkItems
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Work Items that satisfy the
$filterexpression
- orderby? "StartDate"|"StartDate desc"|"DeadlineDate"|"DeadlineDate desc" - When this parameter is combined with the URI, this endpoint will return a list of Work Items, sorted by the available properties. Using the
descvariant will return items in most to least recent order
karbon: ListWorkTemplatesQueries
Represents the Queries record for the operation: listWorkTemplates
Fields
- skip? int - Skip the first n items
- top? int - Limit the number of items returned
- filter? string - When this parameter is combined with the URI, this endpoint will return a subset of the Work Templates that satisfy the
$filterexpression
- orderby "WorkTypeKey"|"WorkTypeKey desc"|"PublishedDate"|"PublishedDate desc"|"NumberOfWorkItemsCreated"|"NumberOfWorkItemsCreated desc"|"DateLastWorkItemCreated"|"DateLastWorkItemCreateddesc"|"DateModified"|"DateModified desc" (default "WorkTypeKey") - When this parameter is combined with the URI, this endpoint will return a list of Work Templates, sorted by the available properties
karbon: ManualPaymentResponse
Fields
- invoiceKey? string - The unique Key of the Invoice which the payment was applied to
- paymentDate? string - The date the payment made by the customer
- reference? anydata - An optional reference to include with the payment
- paymentMethod? string - The method used to make the payment
- atOdataContext? string - The information about Karbon controllers generating this response
- totalAmount? decimal - The amount of the payment
- paymentProcessingKey? string - The unique id of the payment record
karbon: NoteRequest
A single Note
Fields
- authorEmailAddress string - The email address of the Note's author
- assigneeEmailAddress? string - The email address of the the Karbon user that the Note should be assigned to
- timelines? NoteRequestTimeline[] - The Timelines to which this note will be associated. If Notes are linked to a Work Item, the Timeline of the Client (associated with the Work Item) will show the Notes
- todoDate? string - The date for which the actions will be executed
- dueDate? string - The date by which the actions on the note must be complete
- body string - The body of the Note. This property supports HTML
- subject string - The subject line of the Note
karbon: NoteRequestTimeline
Fields
- entityType? "WorkItem"|"Contact"|"Organization"|"ClientGroup" - The type of entity this note will be linked to
- entityKey? string - A Karbon-generated value to indicate the entity
karbon: NoteResponse
A single Contact
Fields
- authorEmailAddress string - The email address of the Note's author
- assigneeEmailAddress string - The email address of the Note's reader
- timelines? NoteResponseTimeline[] - The Timelines to which this note will be associated. If Notes are linked to a Work Item, the Timeline of the Client (associated with the Work Item) will show the Notes
- todoDate? string - The date for which the actions will be executed
- comments? NoteResponseComment[] - The comments for this note
- atOdataContext? string - The information about Karbon controllers generating this response
- id? string - A Karbon-generated value that is used to identify the Note
- dueDate? string - The date by which the actions on the note must be complete
- body string - The body of the Note. This property supports HTML
- subject string - The subject line of the Note
karbon: NoteResponseComment
Fields
- authorEmailAddress? string - The email address of the Comment's author
- commentBody? string - A Karbon-generated value that is used to identify the Comment
- createdDate? string - The date at which the Comment was created
- commentKey? string - A Karbon-generated value that is used to identify the Comment
karbon: NoteResponseTimeline
Fields
- entityType? "WorkItem"|"Contact"|"Organization"|"ClientGroup" - The type of entity this note will be linked to
- entityKey? string - A Karbon-generated value to indicate the entity
karbon: OrganizationClientTeam
Fields
- clientTeam? ClientTeam -
karbon: OrganizationContacts
Fields
- contacts? ContactsCardList -
karbon: OrganizationDetails
A single Organization, including its contacts and client team
Fields
- Fields Included from *WithBusinessCardsCreateOrganizationResponse
- businessCards BusinessCardsRequestAsArray
- contactType string
- lastModifiedDateTime string
- atOdataType string
- entityDescription CreateOrganizationResponseEntityDescription
- fullName string
- clientOwner string
- clientManager string
- restrictionLevel "Public"|"Private"|"Hidden"
- userDefinedIdentifier string
- atOdataContext string
- accountingDetail DetailsOfAccounting
- organizationKey string
- anydata...
- Fields Included from *OrganizationContacts
- contacts ContactsCardList
- anydata...
- Fields Included from *OrganizationClientTeam
- clientTeam ClientTeam
- anydata...
karbon: OrganizationListItem
Fields
- contactType? string - The Contact Type for this Organization. You can only use existing Contact Types, these are available from the TenantSettings endpoint
- lastModifiedDateTime string - The date and time at which the Organization was most recently modified
- atOdataType? string - The information about Karbon Objects generating this response
- fullName string - The full name of the Organization
- userDefinedIdentifier? string? - Your own identifier for the Organization, if one has been set. This matches the behaviour already available on /v3/Contacts
- phoneNumber? string? - The phone number associated with the Organization
- website? string - The website of the Organization
- emailAddress? string - The Email Address of the Organization
- organizationKey string - A Karbon-generated unique identifier for the Organization
karbon: PartialClientGroupUpdateRequest
Fields
- fullName? string - The full name of the Client Group
karbon: PartialContactUpdateRequest
Fields
- suffix? string - The suffix of the Contact
- firstName? string - The first name of the Contact
- lastName? string - The last name of the Contact
- preferredName? string - The preferred name of the Contact
- middleName? string - The middle name of the Contact
- salutation? string - The title to address the Contact
karbon: PartiallyUpdatedContact
Fields
- contactType? string - The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint
- lastModifiedDateTime? string - The date and time at which this Contact was last modified
- atOdataType? string - The information about Karbon Objects generating this response
- firstName? string - The first name of the Contact
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the Contact. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Client Group. <ul><li>Public Client Groups can be managed by anyone in the firm</li> <li>Private Client Groups can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Contacts and the Work Items) related to such Client Groups are visible to anyone in the firm.</li> <li>Hidden Client Groups are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- userDefinedIdentifier? string - A unique key that you can use to identify this Contact
- atOdataContext? string - The information about Karbon controllers generating this response
- middleName? string - The middle name of the Contact
- salutation? string - The title to address the Contact
- suffix? string - The suffix of the Contact
- avatarUrl? string - The URL to the Contact's avatar
- entityDescription? PartiallyUpdatedContactEntityDescription -
- clientManager? string - The team member in your firm who manages the work for Contact. You can only use the UserKey or the email address of an existing team member
- contactKey? string - A Karbon-generated value that is used to identify the Contact
- lastName? string - The last name of the Contact
- preferredName? string - The preferred name of the Contact
- accountingDetail? string? - The accounting details associated with the Contact. This property will be
null
karbon: PartiallyUpdatedContactEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Client Group
karbon: PartiallyUpdatedOrganization
Fields
- contactType? string - The Contact Type for this Organization. You can only use existing Contact Type
- lastModifiedDateTime? string - The date and time at which this Contact was last modified
- atOdataType? string - The information about Karbon Objects generating this response
- entityDescription? CreateOrganizationResponseEntityDescription -
- fullName? string - The full name of the Organization
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- clientManager? string - The team member in your firm who manages the work for the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Organization. <ul><li>Public Organization can be managed by anyone in the firm</li> <li>Private Organization can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Organization and the Work Items) related to such Organization are visible to anyone in the firm.</li> <li>Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- userDefinedIdentifier? string - A unique key that you can use to identify this Organization
- atOdataContext? string - The information about Karbon controllers generating this response
- accountingDetail? string? - The accounting details associated with the Organization. This property will be
null
- organizationKey? string - A Karbon-generated value that is used to identify the Organization
karbon: PartiallyUpdateOrganizationHeaders
Represents the Headers record for the operation: partiallyUpdateOrganization
Fields
- prefer? string - Return the record after it has been updated
karbon: PartialOrganizationUpdateRequest
Fields
- fullName? string - The full name of the Organization
karbon: PaymentList
Fields
- \@odata\.context? string - The information about Karbon controllers generating this response.
- \@odata\.count? int - The total number of results
- values? BillingPayment[] -
karbon: PaymentResponse
A single Payment, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *BillingPayment
- paymentReference string
- paymentDate string
- clientKey string
- paymentType "ManualPayment"|"ManualPaymentReversed"|"Payment"
- paymentMethod string
- paymentKey string
- grossAmount decimal
- karbonPayment BillingKarbonPaymentKarbonPayment
- Client BillingClientClient|()
- anydata...
karbon: RemoveTeamMember
The user profile key to remove from a Team
Fields
- userKey string - The key of the user to remove
karbon: ResponseCreateClientGroup
A single Client Group
Fields
- contactType? string - The Contact Type for this Client Group. You can only use existing Contact Type
- lastModifiedDateTime? string - The date and time at which this Client Group was last modified
- atOdataType? string - The information about Karbon Objects generating this response
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Client Group. <ul><li>Public Client Groups can be managed by anyone in the firm</li> <li>Private Client Groups can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Contacts and the Work Items) related to such Client Groups are visible to anyone in the firm.</li> <li>Hidden Client Groups are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- clientGroupKey string - A Karbon-generated value that is used to identify the Client Group
- userDefinedIdentifier string - A unique key that you can use to identify this Client Group
- atOdataContext? string - The information about Karbon controllers generating this response
- primaryContact? string - The main contact for a client with multiple contact details
- entityDescription? ResponseCreateClientGroupEntityDescription -
- fullName string - The full name of the Client Group
- clientManager? string - The team member in your firm who manages the work for the clients in this Client Group. You can only use the UserKey or the email address of an existing team member
- members? ClientGroupMember[] - The members of the Client Group
karbon: ResponseCreateClientGroupEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Client Group
karbon: ResponseCreateContact
A single Contact
Fields
- contactType? string - The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint
- lastModifiedDateTime? string - The date and time at which this Contact was last modified
- atOdataType? string - The information about Karbon Objects generating this response
- firstName string - The first name of the Contact
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the Contact. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Client Group. <ul><li>Public Client Groups can be managed by anyone in the firm</li> <li>Private Client Groups can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Contacts and the Work Items) related to such Client Groups are visible to anyone in the firm.</li> <li>Hidden Client Groups are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li>
- userDefinedIdentifier string - A unique key that you can use to identify this Contact
- atOdataContext string - The information about Karbon controllers generating this response
- middleName? string - The middle name of the Contact
- salutation? string - The title to address the Contact
- clientTeam? ClientTeam -
- suffix? string - The suffix of the Contact
- avatarUrl? string - The URL to the Contact's avatar
- entityDescription? ResponseCreateContactEntityDescription -
- clientAccess? ClientAccess -
- clientManager? string - The team member in your firm who manages the work for Contact. You can only use the UserKey or the email address of an existing team member
- contactKey string - A Karbon-generated value that is used to identify the Contact
- businessCards? BusinessCardsRequestAsArray -
- lastName string - The last name of the Contact
- preferredName? string - The preferred name of the Contact
- accountingDetail? DetailsOfAccounting -
karbon: ResponseCreateContactEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Client Group
karbon: ReverseManualPaymentRequest
Fields
- PaymentKey string - The unique key of the Manual Payment to reverse
- ReversalDate string - The date the Reversal is to be recorded using an ISO 8601 datestamp
karbon: Role
A Karbon Role (internally an Actor in the Tenant pillar)
Fields
- 'key string - A Karbon-generated unique identifier for the Role
- name string - The name of the Role
karbon: SettingContactType
The name and unique key for a Contact Type
Fields
- contactTypeKey? string - The unique key assigned to the Customer Type
- name? string - The name assigned to the Customer Type
karbon: SettingServiceType
The schema for a single Service Type entry
Fields
- workTypeKeys? string[] -
- serviceTypeKey? string - The unique key assigned to the Service Type
- name? string - The name assigned to the Service Type
karbon: SettingWorkStatus
A Work Status, its child statuses with Name, Type and unique Key
Fields
- 'type? "Primary"|"Secondary" - The type of status, expected to be Primary at this level
- children? SettingWorkStatusChild[] -
- name? string - The name assigned the Work Status
karbon: SettingWorkStatusChild
Fields
- 'type? "Primary"|"Secondary" - The type of Work Status, expected to always be Secondary at this level
- workStatusKey? string - The unique key of the Work Status
- name? string - The name of the Secondary Work Status
karbon: SettingWorkType
The schema for a single Work Type entry
Fields
- workTypeKey? string - The unique key assigned to the Work Type
- availableStatuses? SettingWorkTypeAvailableStatuses -
- name? string - The name assigned to the Work Type
karbon: SettingWorkTypeAvailableStatuses
Fields
- secondary? string[] -
- primary? string[] -
karbon: Team
A Karbon team containing a list of member Users and Teams
Fields
- description? string? - An optional description of the Team
- parentTeamKey? string? - The key of the parent Team when this Team is a sub-team; otherwise null
- teamKey string - A Karbon-generated unique identifier for the Team
- name string - The name of the Team
karbon: TeamMember
A Karbon team member details, either a User or another Team
Fields
- 'type? "User"|"Team" - The kind of member: an individual user, or a sub-team
- 'key? string - The key of the member — a UserKey when Type is 'User', or a TeamKey when Type is 'Team'
- name? string - The display name of the member
karbon: TeamProfile
A single Team including its members
Fields
- Fields Included from *Team
- members? TeamMember[] - The Team's members. Active users and sub-teams only; archived users are excluded
karbon: TimesheetResponse
A single Timesheet, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *GetSingleTimeSheet
karbon: TimesheetTimeEntry
Fields
- timeEntryKey? string - A Karbon-generated key used to identify the Time Entry
- entityKey? string - A Karbon-generated key used to identify the entity this Time Entry is related to
- descriptions? string[] - Free-form text that has more information about the Time Entry
- clientType? string - The type of Client
- roleName? string - The role of the user for whom the Time Entry was created
- billedStatus? "Unbilled"|"Draft"|"InterimBilled"|"Billed" - An indicator that represents whether the time entry has been or is in the process of being billed
- clientKey? string - A Karbon-generated key used to identify the Client this Time Entry is related to
- workItemKey? string - A Karbon-generated key used to identify the Work Item this Time Entry is related to
- taskTypeName? string - The type of task performed by the user
- minutes? int - The total time (in minutes) spent on the task
- hourlyRate? decimal - The hourly rate of the user who worked on the task
karbon: UpdateBusinessCardRequest
The Business Card details to update, with the entity it is connected to
Fields
- entityType? "Contact"|"Organization"|"ClientGroup" - The type of entity that this business card is connected to
- entityKey? string - The unique key for the entity specified this business card is connected to
- Fields Included from *BusinessCardRequest
- webSites string[]
- skypeLink string
- phoneNumbers BusinessCardRequestPhoneNumber[]
- linkedInLink string
- businessCardKey string
- roleOrTitle string|()
- organizationKey string|()
- entityType "Contact"|"Organization"|"ClientGroup"
- addresses BusinessCardRequestAddress[]
- entityKey string
- twitterLink string
- emailAddresses string[]
- facebookLink string
- isPrimaryCard boolean
- anydata...
karbon: UpdateClientGroupRequest
The full set of Client Group details to update, including its business card
Fields
- Fields Included from *CreateClientGroup
- contactType string
- entityDescription ResponseCreateClientGroupEntityDescription
- fullName string
- clientOwner string
- clientManager string
- restrictionLevel "Public"|"Private"|"Hidden"
- userDefinedIdentifier string
- primaryContact string
- members ClientGroupMember[]
- anydata...
- businessCard? BusinessCardRequest -
karbon: UpdateEstimateSummaryRequest
Fields
- estimateMinutes? int - The total estimated time (in minutes) for the task. Between 0 and 599,999,940. Cannot be supplied together with EstimateAmount
- hourlyRate? decimal - The hourly rate to estimate the task at. Between 0 and 99,999,999
- estimateAmount? decimal - The estimated cost of the task. Between 0 and 99,999,999. Cannot be supplied together with EstimateMinutes
karbon: UpdateOrganization
A single Organization
Fields
- contactType? string - The Contact Type for this Organization. You can only use existing Contact Type
- entityDescription? UpdateOrganizationEntityDescription -
- fullName string - The full name of the Organization
- clientOwner? string - The team member in your firm who looks after client relationship or is responsible for the vast majority of the work of the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- clientManager? string - The team member in your firm who manages the work for the clients in this Organization. You can only use the UserKey or the email address of an existing team member
- restrictionLevel "Public"|"Private"|"Hidden" (default "Public") - The privacy level for this Organization. <ul><li>Public Organization can be managed by anyone in the firm</li> <li>Private Organization can only be managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Basic details (name of the Organization and the Work Items) related to such Organization are visible to anyone in the firm.</li> <li>Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team).</li> Setting `Private` requires the calling API application to have the `IncludePrivate` permission; setting `Hidden` requires `IncludeHidden`. `Public` is always allowed. Omitting this field leaves the existing value unchanged
- userDefinedIdentifier? string - A unique key that you can use to identify this Organization
- businessCards? BusinessCardRequest[] -
- accountingDetail? DetailsOfAccounting -
- clientTeam? ClientTeam -
karbon: UpdateOrganizationEntityDescription
Fields
- text? string - Free-form text that can be used to add more information about the Organization
karbon: UpdateWebhookSubscriptionRequest
Fields
- webhookTypes? ("Contact"|"CustomField"|"Work"|"Note"|"User"|"IntegrationTask"|"Invoice"|"EstimateSummary")[] - The full replacement set of resource types this subscription receives notifications for
karbon: UpdateWorkItemAssignee
Fields
- AssigneeEmailAddress? string - The email address of the Karbon user the Work Item should be assigned to. Validated against existing users; unknown values return a
400.
karbon: UpdateWorkItemDeadlineDate
Fields
karbon: UpdateWorkItemDescription
Fields
- Description? string - A free form text field to add more information about the Work Item
karbon: UpdateWorkItemDueDate
Fields
karbon: UpdateWorkItemRoleAssignments
Fields
- UserRoleAssignments? WorkItemUserRoleAssignment[] - The full set of user role assignments for the Work Item. Replaces the existing assignments. Reassigning a role also moves any time estimates on that role to the new user.
karbon: UpdateWorkItemStartDate
Fields
karbon: UpdateWorkItemTitle
Fields
- Title? string - The title of the Work Item. Must be non-empty and no longer than 200 characters when included.
karbon: UpdateWorkItemWorkType
Fields
- WorkType? string - The work type label, validated against work types configured on the account. Unknown values return a
400.
karbon: UpdateWorkSchedule
The properties that can be updated on a Work Schedule with the PATCH method
Fields
- assigneeUserKey? string? - The key of an existing Karbon user to assign the Work Schedule's generated Work Items to. Changing this reassigns every incomplete Work Item in the series; completed Work Items are unchanged. Once set, assignee cannot be cleared
karbon: UpdateWorkScheduleRequest
A single Work Schedule
Fields
- workScheduleKey string - The key of the WorkSchedule, this should match the key used in the URL
- Fields Included from *WorkScheduleRequest
- recurrenceFrequency "Day"|"Week"|"SemiMonth"|"Fortnight"|"Month"|"Quarter"|"Year"|"Custom"
- customFrequencyUnits "Years"|()|"Days"|"Weeks"|"Months"
- initializeBeforeStartDateUnits "Days"|"Weeks"|"Months"|"Years"
- workItemTitleDefinition string
- initializeTasksBeforeStartDateMultiple Signed32
- scheduleDueDateDays Signed32
- initializeTasksBeforeStartDateUnits "Days"|"Weeks"|"Months"|"Years"
- assigneeUserKey string|()
- scheduleStartDate string
- customFrequencyMultiple Signed32
- scheduleEndDate string
- scheduleDeadlineDateMethod "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDeadlineDate"
- createdFromWorkItemKey string
- scheduleDueDateMonthMultiple Signed32
- scheduleDeadlineDateDays Signed32
- initializeBeforeStartDateMultiple Signed32
- preventStartEndOnWeekend boolean
- scheduleDueDateMethod "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDueDate"
- scheduleDeadlineDateMonthMultiple Signed32
- anydata...
karbon: UploadedFile
Fields
- size? string - The size of the file (in bytes)
- atOdataContext? string - The information about Karbon controllers generating this response
- id? string - A Karbon-generated unique identifier for the file
- name? string - The name of the file
karbon: UploadFileRequest
Fields
- integrationTaskKey? string - A Karbon-generated unique identifier for the Integration Task, which this file will be associated with
- file record { fileContent byte[], fileName string } - File to be uploaded
- contactKeys? string - A Karbon-generated unique identifier for the Contact, which this file will be associated with
- clientGroupKeys? string - A Karbon-generated unique identifier for the Client Group, which this file will be associated with
- organizationKeys? string - A Karbon-generated unique identifier for the Organization, which this file will be associated with
- workitemKeys? string - A Karbon-generated unique identifier for the Work Item, which this file will be associated with
karbon: UserResponse
A single User, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *GetSingleUser
karbon: UserRoleItem
Fields
- 'key? string - The unique identifier of the role
- name? string - The name of the role
karbon: UserTeamItem
Fields
- parentTeamKey? string? - The unique key of the parent team, if applicable
- 'key? string - The unique key of the team
- name? string - The name of the team
karbon: WithBusinessCardsCreateOrganizationResponse
The response returned when a business card is created and $expand=BusinessCards is specified in the URL
Fields
- Fields Included from *CreateOrganizationResponse
- contactType string
- lastModifiedDateTime string
- atOdataType string
- entityDescription CreateOrganizationResponseEntityDescription
- fullName string
- clientOwner string
- clientManager string
- restrictionLevel "Public"|"Private"|"Hidden"
- userDefinedIdentifier string
- atOdataContext string
- accountingDetail DetailsOfAccounting
- organizationKey string
- anydata...
- businessCards? BusinessCardsRequestAsArray -
karbon: WorkFeeSettings
The Fee Settings for a Work Item
Fields
- FeeSettings? WorkFeeSettingsFeeSettings - The Fee Settings describe how the work will be billed, for FixedFee work the Fee Settings can include the value to be billed
karbon: WorkFeeSettingsFeeSettings
The Fee Settings describe how the work will be billed, for FixedFee work the Fee Settings can include the value to be billed
Fields
- feeValue? decimal? - The value of the fee in the currency of the Karbon account, this value must be null if FeeType is not FixedFee
- feeType? "FixedFee"|"TimeAndMaterials"|"NonBillable" - The way the fee is calculated for the Work Item
karbon: WorkItem
The base data for a Work Item
Fields
- clientType? "Contact"|"Organization"|"ClientGroup" - The type of the Client
- workTemplateTile? string - The title of the Work Template
- clientKey string - A Karbon-generated value used to identify the Client for whom the Work Item is prepared
- relatedClientGroupKey? string - A Karbon-generated value used to identify the Client Group of the Client
- assigneeKey? string - A Karbon-generated value used to identify the user to whom the Work Item has been assigned
- deadlineDate? string? - The date and time by which the Work Item should be complete according to a party outside of your firm. e.g. A tax filing date or payroll processing cut-off date
- startDate string - The date and time at which the Work Item should start
- clientName? string - The name of the Client for whom the Work Item is prepared
- relatedClientGroupName? string - The name of the related Client Group
- clientUserDefinedIdentifier? string - A unique identifier that you had created to identify the Client. This parameter is not case sensitive
- toDoPeriod? string - The period, in which the Work Item should start
- workStatus? string - The current status of the Work Item
- workItemKey string - A Karbon-generated unique identifier for the Work Item
- dueDate? string - The date and time by which the Work Item should be complete
- assigneeName? string - The name of the user to whom the Work Item has been assigned
- workType? string - The type of work related to the Work Item
- secondaryStatus? string - The current child-level Status of the Work Item
- clientGroupKey? string - A Karbon-generated value used to identify the Client Group of the Client
- title string - The title of the Work Item
- workScheduleKey? string - A Karbon-generated value used to identify the Work Schedule for this Work Item
- primaryStatus? "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed" - The current parent-level Status of the Work Item. If
WorkStatusandPrimaryStatushave different values,PrimaryStatuswill be the source of truth for Work Item status
- workTemplateKey? string - A Karbon-generated value used to identify the Template that generated this Work Item
- completedDate? string - The date and time at which the Work Item was completed
- assigneeEmailAddress? string - The email address of the user to whom the Work Item has been assigned
- estimatedBudget? decimal - Deprecated! - previously used as the estimated budget for the Work Item
karbon: WorkItemDescription
Fields
- description? string - A free form text field to add more information about the Work Item
- clientTaskRecipient? string - The details about the recipient of the Client Tasks related to this Work Item. This property will always return
null
karbon: WorkItemDetails
A single Work Item, including its fee settings and user role assignments
Fields
- Fields Included from *WorkItemODataInfo
- Fields Included from *WorkItemWithFeeSettingsAndUserRoleAssignments
- clientType "Contact"|"Organization"|"ClientGroup"
- workTemplateTile string
- clientKey string
- relatedClientGroupKey string
- assigneeKey string
- deadlineDate string|()
- startDate string
- clientName string
- relatedClientGroupName string
- clientUserDefinedIdentifier string
- toDoPeriod string
- workStatus string
- workItemKey string
- dueDate string
- assigneeName string
- workType string
- secondaryStatus string
- clientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- completedDate string
- assigneeEmailAddress string
- estimatedBudget decimal
- FeeSettings WorkFeeSettingsFeeSettings
- UserRoleAssignments WorkItemUserRoleAssignment[]
- anydata...
- Fields Included from *WorkItemDescription
karbon: WorkItemListItem
Fields
- atOdataType? string - The information about Karbon Objects generating this response
- Fields Included from *WorkItem
- clientType "Contact"|"Organization"|"ClientGroup"
- workTemplateTile string
- clientKey string
- relatedClientGroupKey string
- assigneeKey string
- deadlineDate string|()
- startDate string
- clientName string
- relatedClientGroupName string
- clientUserDefinedIdentifier string
- toDoPeriod string
- workStatus string
- workItemKey string
- dueDate string
- assigneeName string
- workType string
- secondaryStatus string
- clientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- completedDate string
- assigneeEmailAddress string
- estimatedBudget decimal
- anydata...
karbon: WorkItemODataInfo
Fields
- atOdataType? string - The information about Karbon Objects generating this response
- atOdataContext? string - The information about Karbon controllers generating this response
karbon: WorkItemUpdate
The core parameters when updating a Work Item
Fields
- clientType "Contact"|"Organization"|"ClientGroup" - The type of the Client
- description? string - A free form text field to add more information about the Work Item
- workType? string - The type of work related to the Work Item. Enter an existing Work Type
- secondaryStatus? string - The current child-level Status of the Work Item
- clientKey string - A Karbon-generated value used to identify the Client for whom the Work Item is prepared
- relatedClientGroupKey? string - A Karbon-generated value used to identify the Client Group of the Client
- title string - The title of the Work Item
- workScheduleKey? string - A Karbon-generated value used to identify the Work Schedule for this Work Item
- primaryStatus? "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed" - The current parent-level Status of the Work Item. If
WorkStatusandPrimaryStatushave different values,PrimaryStatuswill be the source of truth for Work Item status
- workTemplateKey? string - A Karbon-generated value used to identify the Template that will be used to generate this Work Item
- deadlineDate? string? - The date and time by which an external party has specified that the Work Item should be complete
- startDate string - The date and time at which the Work Item should start
- assigneeEmailAddress string - The email address of the user to whom the Work Item has been assigned
- workStatus? string - The current status of the Work Item
- clientTaskRecipient? WorkItemUpdateClientTaskRecipient -
- dueDate? string - The date and time by which the Work Item should be complete
- estimatedBudget? decimal - The estimated budget for the Work Item
karbon: WorkItemUpdateClientTaskRecipient
The details about the recipient of the Client Tasks related to this Work Item
Fields
- linkType "Contact"|"Organization" - The Karbon entity, from which to pull the email address in case the email address of the Client Task recipient is empty
- emailAddress? string - The email address of the recipient
- recipientKey string - A Karbon-generated value used to identify the Client
karbon: WorkItemUserRoleAssignment
Fields
- roleKey string - A Karbon-generated value used to identify the role of the user
- userProfileKey string - A Karbon-generated value used to identify the user
karbon: WorkItemUserRoleAssignments
The User assignments for specific Roles on a Work Item
Fields
- UserRoleAssignments? WorkItemUserRoleAssignment[] - The array that describes the roles of the users associated with this Work Item.
karbon: WorkItemWithFeeSettings
A Work Item with Fee Settings
Fields
- Fields Included from *WorkItem
- clientType "Contact"|"Organization"|"ClientGroup"
- workTemplateTile string
- clientKey string
- relatedClientGroupKey string
- assigneeKey string
- deadlineDate string|()
- startDate string
- clientName string
- relatedClientGroupName string
- clientUserDefinedIdentifier string
- toDoPeriod string
- workStatus string
- workItemKey string
- dueDate string
- assigneeName string
- workType string
- secondaryStatus string
- clientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- completedDate string
- assigneeEmailAddress string
- estimatedBudget decimal
- anydata...
- Fields Included from *WorkFeeSettings
- FeeSettings WorkFeeSettingsFeeSettings
- anydata...
karbon: WorkItemWithFeeSettingsAndUserRoleAssignments
A Work Item with Fee Settings and User Role assignments
Fields
- Fields Included from *WorkItem
- clientType "Contact"|"Organization"|"ClientGroup"
- workTemplateTile string
- clientKey string
- relatedClientGroupKey string
- assigneeKey string
- deadlineDate string|()
- startDate string
- clientName string
- relatedClientGroupName string
- clientUserDefinedIdentifier string
- toDoPeriod string
- workStatus string
- workItemKey string
- dueDate string
- assigneeName string
- workType string
- secondaryStatus string
- clientGroupKey string
- title string
- workScheduleKey string
- primaryStatus "Planned"|"ReadyToStart"|"InProgress"|"Waiting"|"Completed"
- workTemplateKey string
- completedDate string
- assigneeEmailAddress string
- estimatedBudget decimal
- anydata...
- Fields Included from *WorkFeeSettings
- FeeSettings WorkFeeSettingsFeeSettings
- anydata...
- Fields Included from *WorkItemUserRoleAssignments
- UserRoleAssignments WorkItemUserRoleAssignment[]
- anydata...
karbon: WorkScheduleRequest
A single Work Schedule
Fields
- recurrenceFrequency "Day"|"Week"|"SemiMonth"|"Fortnight"|"Month"|"Quarter"|"Year"|"Custom" - The unit of time at which this Work Schedule should repeat. Once set, the value of this property can not be changed
- customFrequencyUnits? "Days"|"Weeks"|"Months"|"Years"? - The unit of time at which this Work Schedule should repeat. Once set, the value of this property can not be changed.
This property is only applicable if
RecurrenceFrequencyis set toCustom
- initializeBeforeStartDateUnits? "Days"|"Weeks"|"Months"|"Years" - You can automatically create a Work Item before its Start date. Use this property to set the unit of delay between Start date and Work Item creation date
- workItemTitleDefinition string - Use this property to define the format of the Work Item title. Karbon offers a series of object that you can use to construct Work Item Title. For more information, see Technical Guide to Work Item Title Definition
- initializeTasksBeforeStartDateMultiple Signed32 - You can automatically create budget and tasks for a Work Item before its Start date. Use this property to set the multiple of delay unit between Start date and task creation date
- scheduleDueDateDays? Signed32 - The value of the count for the Due Date
This property is not applicable if
ScheduleDueDateMethodis set toLastDayOfMonthorNoDueDate. Example of usage: <table> <thead> <th>ScheduleDueDateMethod</th> <th>ScheduleDueDateDays</th> <th>Read Due Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>7 days after start date</td> </tr> <tr> <td>DayOfMonth</td> <td>7</td> <td>7th day of the current month</td> </tr> <tr> <td>LastDayOfMonth</td> <td>N/A</td> <td>Last day of the current month</td> </tr> <tr> <td>DayOfNextMonth</td> <td>7</td> <td>7th day of the next month</td> </tr> <tr> <td>NoDueDate</td> <td>N/A</td> <td>Work has no due date</td> </tr> </tbody> </table>
- initializeTasksBeforeStartDateUnits "Days"|"Weeks"|"Months"|"Years" - You can automatically create budget and tasks for a Work Item before its Start date. Use this property to set the unit of delay between Start date and task creation date
- assigneeUserKey? string? - The key of an existing Karbon user to assign the Work Schedule's generated Work Items to. On PUT, a null or omitted value leaves the current assignee unchanged. Once set, assignee cannot be cleared. Changing the assignee reassigns every incomplete Work Item in the series; completed Work Items are unchanged
- scheduleStartDate string - The date at which this Work Schedule should start running
- customFrequencyMultiple Signed32 - The multiple of time unit at which this Work Schedule should repeat. This property is not applicable if
RecurrenceFrequencyis set toSemiMonth,Fortnight, orQuarter
- scheduleEndDate? string - The date at which this Work Schedule should stop running
To set the Work Schedule to run forever, set the value of this property to
null
- scheduleDeadlineDateMethod? "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDeadlineDate" - The method that should be used to count the Deadline Date for the Work Item.
Companies House-driven and filing-date-driven deadline methods are not available through the API; setting
ScheduleDeadlineDateMethodtoCompaniesHouseAccountsDueDate,CompaniesHouseConfirmationStatementDueDateorOnFilingDatereturns a400. OnPUT, omitting this property leaves the existing deadline date configuration unchanged. To remove a deadline date, set this toNoDeadlineDateexplicitly
- createdFromWorkItemKey string - The key of the Work Item, which the Work Schedule will be assigned to. This value will be
null
- scheduleDueDateMonthMultiple? Signed32 - The value to denote the number of the months, if the due date is after 2 months.
This property is only applicable if
ScheduleDueDateMethodis set toDayOfSubsequentMonth. Example of usage: <table> <thead> <th>ScheduleDueDateMethod</th> <th>ScheduleDueDateDays</th> <th>ScheduleDueDateMonthMultiple</th> <th>Read Due Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>3</td> <td>7th day of the 3rd month after start date</td> </tr> </tbody> </table>
- scheduleDeadlineDateDays? Signed32 - The value of the count for the Deadline Date
This property is not applicable if
ScheduleDeadlineDateMethodis set toLastDayOfMonthorNoDeadlineDate. Example of usage: <table> <thead> <th>ScheduleDeadlineDateMethod</th> <th>ScheduleDeadlineDateDays</th> <th>Read Deadline Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>7 days after start date</td> </tr> <tr> <td>DayOfMonth</td> <td>7</td> <td>7th day of the current month</td> </tr> <tr> <td>LastDayOfMonth</td> <td>N/A</td> <td>Last day of the current month</td> </tr> <tr> <td>DayOfNextMonth</td> <td>7</td> <td>7th day of the next month</td> </tr> <tr> <td>NoDeadlineDate</td> <td>N/A</td> <td>Work has no deadline date</td> </tr> </tbody> </table>
- initializeBeforeStartDateMultiple? Signed32 - You can automatically create a Work Item before its Start date. Use this property to set the multiple of delay unit between Start date and Work Item creation date
- preventStartEndOnWeekend boolean - If the value of this property is set to
true, the Work Item will not start on Weekends
- scheduleDueDateMethod "DaysFromStartDate"|"DayOfMonth"|"LastDayOfMonth"|"DayOfNextMonth"|"DayOfSubsequentMonth"|"NoDueDate" - The method that should be used to count the Due Date for the Work Item
- scheduleDeadlineDateMonthMultiple? Signed32 - The value to denote the number of the months, if the deadline date is after 2 months.
This property is only applicable if
ScheduleDeadlineDateMethodis set toDayOfSubsequentMonth. Example of usage: <table> <thead> <th>ScheduleDeadlineDateMethod</th> <th>ScheduleDeadlineDateDays</th> <th>ScheduleDeadlineDateMonthMultiple</th> <th>Read Deadline Date as</th> </thead> <tbody> <tr> <td>DaysFromStartDate</td> <td>7</td> <td>3</td> <td>7th day of the 3rd month after start date</td> </tr> </tbody> </table>
karbon: WorkTemplateActorRole
Fields
- actorKey? string - A Karbon-generated unique identifier for the user role
- actorName? string - The name of the user role
karbon: WorkTemplateResponse
A single Work Template, with the OData context of the response
Fields
- atOdataContext? string - The information about Karbon controllers generating this response
- Fields Included from *GetSingleWorkTemplate
- hasScheduledClientTaskGroups boolean
- estimatedTime string
- description string
- title string
- workTemplateKey string
- actorRoles WorkTemplateActorRole[]
- draftHasChanges boolean
- workTypeKey string
- numberOfWorkItemsCreated decimal
- publishedDate string
- estimatedBudget string|()
- dateLastWorkItemCreated string
- dateModified string
- anydata...
Union types
karbon: UpdateWorkItem
UpdateWorkItem
The properties that can be updated on a Work Item with the PATCH method
Array types
karbon: ClientTeam
ClientTeam
The Client Team associated with a contact or organization
karbon: ContactsCardList
ContactsCardList
karbon: ClientAccess
ClientAccess
A list of Organizations and People that the contact has been granted access to view in Karbon for Clients
karbon: BusinessCardsRequestAsArray
BusinessCardsRequestAsArray
A collection of business cards
String types
Import
import ballerinax/karbon;Metadata
Released date: about 17 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 41
Current verison: 1
Weekly downloads
Keywords
Vendor/Karbon
Area/ERP & Business Operations
Type/Connector
Contributors