Karbon

App · 20 actions

Manage accounting clients, work items and client groups; read invoices, users and work templates.

Actions

ActionWhat it does
Create client groupCreate client group.
Create contactCreate contact.
Create organizationCreate organization.
Create work itemCreate work item.
Get client groupGet client group.
Get contactGet contact.
Get invoiceGet invoice.
Get organizationGet organization.
Get tenant settingsGet tenant settings.
Get work itemGet work item.
List client groupsList client groups.
List contactsList contacts.
List invoicesList invoices.
List organizationsList organizations.
List usersList users.
List work itemsList work items.
List work templatesList work templates.
Update contactUpdate contact.
Update organizationUpdate organization.
Update work itemUpdate work item.

Create client group

Create client group.

Inputs

Full namefull_nametextRequired
The full name of the Client Group
Client ownerclient_ownertext
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.
Client managerclient_managertext
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.
Contact typecontact_typetext
The Contact Type for this Client Group. You can only use existing Contact Type.
User defined IDentifieruser_defined_identifiertext
A unique key that you can use to identify this Client Group.
Restriction levelrestriction_leveltext
The privacy level for this Client Group. Public Client Groups can be managed by anyone in the firm 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. 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).One of: Public, Private, Hidden. Default: Public.
Primary contactprimary_contacttext
The main contact for a client with multiple contact details.
Entity descriptionentity_descriptionobject
Entity description.
Membersmemberslist
The members of the Client Group
Accounting detailsaccounting_detailstext
The accounting details associated with the Client Group. This property will be `null`.
Business cardbusiness_cardobject
A business card associated with a contact or organization
Client teamclient_teamlist
The Client Team associated with a contact or organization

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetails": "example",
    "BusinessCard": {
      "Addresses": [],
      "BusinessCardKey": "example",
      "EmailAddresses": [],
      "EntityKey": "example",
      "EntityType": "Contact",
      "FacebookLink": "example",
      "IsPrimaryCard": false,
      "LinkedInLink": "example",
      "OrganizationKey": "example",
      "PhoneNumbers": [],
      "RoleOrTitle": "example",
      "SkypeLink": "example",
      "TwitterLink": "example",
      "WebSites": []
    },
    "ClientGroupKey": "example",
    "ClientManager": "example",
    "ClientOwner": "example",
    "ClientTeam": [],
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FullName": "example",
    "LastModifiedDateTime": "example",
    "Members": [],
    "PrimaryContact": "example",
    "RestrictionLevel": "Public",
    "UserDefinedIdentifier": "example"
  }
}

Create contact

Create contact.

Inputs

First namefirst_nametextRequired
The first name of the Contact
Middle namemiddle_nametext
The middle name of the Contact
Last namelast_nametextRequired
The last name of the Contact
Preferred namepreferred_nametext
The preferred name of the Contact
Salutationsalutationtext
The title to address the Contact
Suffixsuffixtext
The suffix of the Contact
Restriction levelrestriction_leveltext
The privacy level for this Contact. Public Contacts can be managed by anyone in the firm 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. Hidden Contacts are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Setting `Private` requiresOne of: Public, Private, Hidden. Default: Public.
Client ownerclient_ownertext
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.
Client managerclient_managertext
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.
Contact typecontact_typetext
The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint.
User defined IDentifieruser_defined_identifiertext
A unique key that you can use to identify this Contact.
Business cardsbusiness_cardslist
Business cards.
Entity descriptionentity_descriptionobject
Entity description.
Accounting detailaccounting_detailobject
The details specific to the Accounting firm related to this entity
Client teamclient_teamlist
The Client Team associated with a contact or organization

Outputs

dataobject
A single Contact
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": {
      "Accounting": [],
      "AnnualRevenue": 1.0,
      "Bank": [],
      "BaseCurrency": "example",
      "Benefits": [],
      "BillPay": [],
      "BirthDate": "example",
      "ContactPermaKey": "example",
      "DateSignedEngagement": "example",
      "DeathDate": "example",
      "EntityType": "Corporation",
      "Expenses": [],
      "FileManagement": [],
      "FinancialYearEndDay": 1,
      "FinancialYearEndMonth": 1,
      "GstBasis": "Cash",
      "GstPeriod": "example",
      "IncomeTaxInstallmentPeriod": "Monthly",
      "IncorporationDate": "example",
      "IncorporationState": "example",
      "IsVATRegistered": false,
      "LegalFirm": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "LegalName": "example",
      "LineOfBusiness": "example",
      "Notes": [],
      "OrganizationPermaKey": "example",
      "OrganizationValuation": 1.0,
      "Payroll": [],
      "PaysTax": false,
      "PrepareGST": false,
      "ProvisionalTaxBasis": "example",
      "ProvisionalTaxRatio": "example",
      "RegistrationNumbers": [],
      "Revenue": [],
      "RevenueModel": "Advertising",
      "SalesTaxBasis": "Cash",
      "SalesTaxPeriod": "example",
      "Salutation": "Mr",
      "Sells": "Services",
      "Sex": "M",
      "TaxCountryCode": "US",
      "TaxProvider": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "TradingName": "example"
    },
    "AvatarUrl": "example",
    "BusinessCards": [],
    "ClientAccess": [],
    "ClientManager": "example",
    "ClientOwner": "example",
    "ClientTeam": [],
    "ContactKey": "example",
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FirstName": "example",
    "LastModifiedDateTime": "example",
    "LastName": "example",
    "MiddleName": "example",
    "PreferredName": "example",
    "RestrictionLevel": "Public",
    "Salutation": "example",
    "Suffix": "example",
    "UserDefinedIdentifier": "example"
  }
}

Create organization

Create organization.

Inputs

Full namefull_nametextRequired
The full name of the Organization
Client ownerclient_ownertext
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.
Client managerclient_managertext
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.
Contact typecontact_typetext
The Contact Type for this Organization. You can only use existing Contact Type.
User defined IDentifieruser_defined_identifiertext
A unique key that you can use to identify this Organization.
Restriction levelrestriction_leveltext
The privacy level for this Organization. Public Organization can be managed by anyone in the firm 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. Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). SeOne of: Public, Private, Hidden. Default: Public.
Business cardsbusiness_cardslist
Business cards.
Entity descriptionentity_descriptionobject
Entity description.
Accounting detailaccounting_detailobject
The details specific to the Accounting firm related to this entity
Client teamclient_teamlist
The Client Team associated with a contact or organization

Outputs

dataobject
A single Organization
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": {
      "Accounting": [],
      "AnnualRevenue": 1.0,
      "Bank": [],
      "BaseCurrency": "example",
      "Benefits": [],
      "BillPay": [],
      "BirthDate": "example",
      "ContactPermaKey": "example",
      "DateSignedEngagement": "example",
      "DeathDate": "example",
      "EntityType": "Corporation",
      "Expenses": [],
      "FileManagement": [],
      "FinancialYearEndDay": 1,
      "FinancialYearEndMonth": 1,
      "GstBasis": "Cash",
      "GstPeriod": "example",
      "IncomeTaxInstallmentPeriod": "Monthly",
      "IncorporationDate": "example",
      "IncorporationState": "example",
      "IsVATRegistered": false,
      "LegalFirm": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "LegalName": "example",
      "LineOfBusiness": "example",
      "Notes": [],
      "OrganizationPermaKey": "example",
      "OrganizationValuation": 1.0,
      "Payroll": [],
      "PaysTax": false,
      "PrepareGST": false,
      "ProvisionalTaxBasis": "example",
      "ProvisionalTaxRatio": "example",
      "RegistrationNumbers": [],
      "Revenue": [],
      "RevenueModel": "Advertising",
      "SalesTaxBasis": "Cash",
      "SalesTaxPeriod": "example",
      "Salutation": "Mr",
      "Sells": "Services",
      "Sex": "M",
      "TaxCountryCode": "US",
      "TaxProvider": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "TradingName": "example"
    },
    "ClientManager": "example",
    "ClientOwner": "example",
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FullName": "example",
    "LastModifiedDateTime": "example",
    "OrganizationKey": "example",
    "RestrictionLevel": "Public",
    "UserDefinedIdentifier": "example"
  }
}

Create work item

Create work item.

Inputs

Assignee email addressassignee_email_addresstextRequired
The email address of the user to whom the Work Item has been assigned
TitletitletextRequired
The title of the Work Item
Client keyclient_keytextRequired
A Karbon-generated value used to identify the Client for whom the Work Item is prepared
Client typeclient_typetextRequired
The type of the ClientOne of: Contact, Organization, ClientGroup.
Related client group keyrelated_client_group_keytext
A Karbon-generated value used to identify the Client Group of the Client
Start datestart_datedate and timeRequired
The date and time at which the Work Item should start
Due datedue_datedate and time
The date and time by which the Work Item should be complete
Deadline datedeadline_datedate and time
The date and time by which an external party has specified that the Work Item should be complete
Work typework_typetext
The type of work related to the Work Item. Enter an existing Work Type.
Work statuswork_statustext
The current status of the Work Item
Primary statusprimary_statustext
The current parent-level Status of the Work Item. If `WorkStatus` and `PrimaryStatus` have different values, `PrimaryStatus` will be the source of truth for Work Item status.One of: Planned, ReadyToStart, InProgress, Waiting, Completed.
Secondary statussecondary_statustext
The current child-level Status of the Work Item
Work template keywork_template_keytext
A Karbon-generated value used to identify the Template that will be used to generate this Work Item
Work schedule keywork_schedule_keytext
A Karbon-generated value used to identify the Work Schedule for this Work Item
Estimated budgetestimated_budgetnumber
The estimated budget for the Work Item
Descriptiondescriptiontext
A free form text field to add more information about the Work Item
Client task recipientclient_task_recipientobject
The details about the recipient of the Client Tasks related to this Work Item.
Fee settingsfee_settingsobject
The Fee Settings describe how the work will be billed, for FixedFee work the Fee Settings can include the value to be billed
User role assignmentsuser_role_assignmentslist
The array that describes the roles of the users associated with this Work Item.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AssigneeEmailAddress": "example",
    "AssigneeKey": "example",
    "AssigneeName": "example",
    "ClientGroupKey": "example",
    "ClientKey": "example",
    "ClientName": "example",
    "ClientTaskRecipient": {
      "EmailAddress": "example",
      "LinkType": "Contact",
      "RecipientKey": "example"
    },
    "ClientType": "Contact",
    "ClientUserDefinedIdentifier": "example",
    "CompletedDate": "example",
    "DeadlineDate": "example",
    "DeadlineDateFilingDeadline": "example",
    "DeadlineDateResolveType": "FilingDeadline",
    "Description": "example",
    "DueDate": "example",
    "DueDateFilingDeadline": "example",
    "DueDateResolveType": "FilingDeadline",
    "EstimatedBudget": 1.0,
    "FeeSettings": {
      "FeeType": "FixedFee",
      "FeeValue": 1.0
    },
    "LastModifiedDateTime": "example",
    "PrimaryStatus": "Planned",
    "RelatedClientGroupKey": "example",
    "RelatedClientGroupName": "example",
    "SecondaryStatus": "example",
    "StartDate": "example",
    "Title": "example",
    "ToDoPeriod": "example",
    "UserRoleAssignments": [],
    "WorkItemKey": "example",
    "WorkScheduleKey": "example",
    "WorkStatus": "example",
    "WorkTemplateKey": "example",
    "WorkTemplateTile": "example",
    "WorkType": "example"
  }
}

Get client group

Get client group.

Inputs

Client groupkeyclient_groupkeytextRequired
Client groupkey.
Expandexpandtext
Expand.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetails": "example",
    "BusinessCard": {
      "Addresses": [],
      "BusinessCardKey": "example",
      "EmailAddresses": [],
      "EntityKey": "example",
      "EntityType": "Contact",
      "FacebookLink": "example",
      "IsPrimaryCard": false,
      "LinkedInLink": "example",
      "OrganizationKey": "example",
      "PhoneNumbers": [],
      "RoleOrTitle": "example",
      "SkypeLink": "example",
      "TwitterLink": "example",
      "WebSites": []
    },
    "ClientGroupKey": "example",
    "ClientManager": "example",
    "ClientOwner": "example",
    "ClientTeam": [],
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FullName": "example",
    "LastModifiedDateTime": "example",
    "Members": [],
    "PrimaryContact": "example",
    "RestrictionLevel": "Public",
    "UserDefinedIdentifier": "example"
  }
}

Get contact

Get contact.

Inputs

ContactkeycontactkeytextRequired
Contactkey.
Expandexpandtext
Expand.One of: BusinessCards, ClientTeam, ClientAccess, ServiceTypes.

Outputs

dataobject
A single Contact
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": {
      "Accounting": [],
      "AnnualRevenue": 1.0,
      "Bank": [],
      "BaseCurrency": "example",
      "Benefits": [],
      "BillPay": [],
      "BirthDate": "example",
      "ContactPermaKey": "example",
      "DateSignedEngagement": "example",
      "DeathDate": "example",
      "EntityType": "Corporation",
      "Expenses": [],
      "FileManagement": [],
      "FinancialYearEndDay": 1,
      "FinancialYearEndMonth": 1,
      "GstBasis": "Cash",
      "GstPeriod": "example",
      "IncomeTaxInstallmentPeriod": "Monthly",
      "IncorporationDate": "example",
      "IncorporationState": "example",
      "IsVATRegistered": false,
      "LegalFirm": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "LegalName": "example",
      "LineOfBusiness": "example",
      "Notes": [],
      "OrganizationPermaKey": "example",
      "OrganizationValuation": 1.0,
      "Payroll": [],
      "PaysTax": false,
      "PrepareGST": false,
      "ProvisionalTaxBasis": "example",
      "ProvisionalTaxRatio": "example",
      "RegistrationNumbers": [],
      "Revenue": [],
      "RevenueModel": "Advertising",
      "SalesTaxBasis": "Cash",
      "SalesTaxPeriod": "example",
      "Salutation": "Mr",
      "Sells": "Services",
      "Sex": "M",
      "TaxCountryCode": "US",
      "TaxProvider": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "TradingName": "example"
    },
    "AvatarUrl": "example",
    "BusinessCards": [],
    "ClientAccess": [],
    "ClientManager": "example",
    "ClientOwner": "example",
    "ClientTeam": [],
    "ContactKey": "example",
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FirstName": "example",
    "LastModifiedDateTime": "example",
    "LastName": "example",
    "MiddleName": "example",
    "PreferredName": "example",
    "RestrictionLevel": "Public",
    "Salutation": "example",
    "Suffix": "example",
    "UserDefinedIdentifier": "example"
  }
}

Get invoice

Get invoice.

Inputs

Invoice keyinvoice_keytextRequired
Invoice key.
Expandexpandtext
Expand.One of: LineItems, Payments, Data, LineItems,Data, LineItems,Payments, LineItems,Payments,Data, Payments,Data.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "Client": {
      "AddressLine": "example",
      "City": "example",
      "ClientKey": "example",
      "ClientType": "example",
      "Country": "example",
      "EmailAddress": "example",
      "Name": "example",
      "StateProvinceCounty": "example",
      "ZipCode": "example"
    },
    "CurrencyCode": "example",
    "Data": [],
    "InvoiceDate": "example",
    "InvoiceKey": "example",
    "InvoiceMagicLink": "example",
    "InvoiceNumber": "example",
    "InvoicePdfUrl": "example",
    "InvoiceStatus": "Approved",
    "InvoiceSubTotal": 1.0,
    "InvoiceTaxTotal": 1.0,
    "InvoiceTotal": 1.0,
    "LineItems": [],
    "PaymentDueDate": "example",
    "PaymentInstructions": "example",
    "Payments": [],
    "TaxLineItems": [],
    "TotalAmountDue": 1.0,
    "UpdatedAt": "example"
  }
}

Get organization

Get organization.

Inputs

OrganizationkeyorganizationkeytextRequired
Organizationkey.
Expandexpandtext
Expand.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": {
      "Accounting": [],
      "AnnualRevenue": 1.0,
      "Bank": [],
      "BaseCurrency": "example",
      "Benefits": [],
      "BillPay": [],
      "BirthDate": "example",
      "ContactPermaKey": "example",
      "DateSignedEngagement": "example",
      "DeathDate": "example",
      "EntityType": "Corporation",
      "Expenses": [],
      "FileManagement": [],
      "FinancialYearEndDay": 1,
      "FinancialYearEndMonth": 1,
      "GstBasis": "Cash",
      "GstPeriod": "example",
      "IncomeTaxInstallmentPeriod": "Monthly",
      "IncorporationDate": "example",
      "IncorporationState": "example",
      "IsVATRegistered": false,
      "LegalFirm": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "LegalName": "example",
      "LineOfBusiness": "example",
      "Notes": [],
      "OrganizationPermaKey": "example",
      "OrganizationValuation": 1.0,
      "Payroll": [],
      "PaysTax": false,
      "PrepareGST": false,
      "ProvisionalTaxBasis": "example",
      "ProvisionalTaxRatio": "example",
      "RegistrationNumbers": [],
      "Revenue": [],
      "RevenueModel": "Advertising",
      "SalesTaxBasis": "Cash",
      "SalesTaxPeriod": "example",
      "Salutation": "Mr",
      "Sells": "Services",
      "Sex": "M",
      "TaxCountryCode": "US",
      "TaxProvider": {
        "Name": "example",
        "OrganizationKey": "example"
      },
      "TradingName": "example"
    },
    "BusinessCards": [],
    "ClientManager": "example",
    "ClientOwner": "example",
    "ClientTeam": [],
    "ContactType": "example",
    "Contacts": [],
    "EntityDescription": {
      "Text": "example"
    },
    "FullName": "example",
    "LastModifiedDateTime": "example",
    "OrganizationKey": "example",
    "RestrictionLevel": "Public",
    "UserDefinedIdentifier": "example"
  }
}

Get tenant settings

Get tenant settings.

Inputs

None.

Outputs

dataobject
A collection of customer specific Contact and Work settings
Example output
{
  "data": {
    "ClientAccessActivated": false,
    "ContactTypes": [],
    "FilingDeadlines": [],
    "ServiceTypes": [],
    "TenantKey": "example",
    "WorkStatuses": [],
    "WorkTypes": []
  }
}

Get work item

Get work item.

Inputs

Work item keywork_item_keytextRequired
Work item key.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AssigneeEmailAddress": "example",
    "AssigneeKey": "example",
    "AssigneeName": "example",
    "ClientGroupKey": "example",
    "ClientKey": "example",
    "ClientName": "example",
    "ClientTaskRecipient": {
      "EmailAddress": "example",
      "LinkType": "Contact",
      "RecipientKey": "example"
    },
    "ClientType": "Contact",
    "ClientUserDefinedIdentifier": "example",
    "CompletedDate": "example",
    "DeadlineDate": "example",
    "DeadlineDateFilingDeadline": "example",
    "DeadlineDateResolveType": "FilingDeadline",
    "Description": "example",
    "DueDate": "example",
    "DueDateFilingDeadline": "example",
    "DueDateResolveType": "FilingDeadline",
    "EstimatedBudget": 1.0,
    "FeeSettings": {
      "FeeType": "FixedFee",
      "FeeValue": 1.0
    },
    "LastModifiedDateTime": "example",
    "PrimaryStatus": "Planned",
    "RelatedClientGroupKey": "example",
    "RelatedClientGroupName": "example",
    "SecondaryStatus": "example",
    "StartDate": "example",
    "Title": "example",
    "ToDoPeriod": "example",
    "UserRoleAssignments": [],
    "WorkItemKey": "example",
    "WorkScheduleKey": "example",
    "WorkStatus": "example",
    "WorkTemplateKey": "example",
    "WorkTemplateTile": "example",
    "WorkType": "example"
  }
}

List client groups

List client groups.

Inputs

Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.Default: ClientGroupKey.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A list of Client Groups
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

List contacts

List contacts.

Inputs

Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.One of: FullName, FullName desc, LastModifiedDateTime, LastModifiedDateTime desc.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A list of Contacts
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

List invoices

List invoices.

Inputs

Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.
Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "value": []
  }
}

List organizations

List organizations.

Inputs

Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.One of: FullName, FullName desc, LastModifiedDateTime, LastModifiedDateTime desc.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A list of Organizations
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

List users

List users.

Inputs

Filterfiltertext
Filter.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A collection of Users
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

List work items

List work items.

Inputs

Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.One of: StartDate, StartDate desc, DeadlineDate, DeadlineDate desc.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A collection of work items
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

List work templates

List work templates.

Inputs

Filterfiltertext
Filter.
Orderbyorderbytext
Orderby.One of: WorkTypeKey, WorkTypeKey desc, PublishedDate, PublishedDate desc, NumberOfWorkItemsCreated, NumberOfWorkItemsCreated desc, DateLastWorkItemCreated, DateLastWorkItemCreated desc, DateModified, DateModified desc. Default: WorkTypeKey.
Skipskipnumber
Skip.From 0 to 100.
Toptopnumber
Top.At least 0.

Outputs

dataobject
A collection of Work Templates
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}

Update contact

Update contact.

Inputs

ContactkeycontactkeytextRequired
Contactkey.
First namefirst_nametext
The first name of the Contact
Middle namemiddle_nametext
The middle name of the Contact
Last namelast_nametext
The last name of the Contact
Preferred namepreferred_nametext
The preferred name of the Contact
Salutationsalutationtext
The title to address the Contact
Suffixsuffixtext
The suffix of the Contact
Client ownerclient_ownertext
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.
Client managerclient_managertext
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.
Contact typecontact_typetext
The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint.
User defined IDentifieruser_defined_identifiertext
A unique key that you can use to identify this Contact.
Restriction levelrestriction_leveltext
The privacy level for this Contact. Public Contacts can be managed by anyone in the firm 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. Hidden Contacts are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). Setting `Private` requiresOne of: Public, Private, Hidden.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": "example",
    "AvatarUrl": "example",
    "ClientManager": "example",
    "ClientOwner": "example",
    "ContactKey": "example",
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FirstName": "example",
    "LastModifiedDateTime": "example",
    "LastName": "example",
    "MiddleName": "example",
    "PreferredName": "example",
    "RestrictionLevel": "Public",
    "Salutation": "example",
    "Suffix": "example",
    "UserDefinedIdentifier": "example"
  }
}

Update organization

Update organization.

Inputs

OrganizationkeyorganizationkeytextRequired
Organizationkey.
Preferprefertext
Prefer.
Full namefull_nametext
The full name of the Organization
Client ownerclient_ownertext
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.
Client managerclient_managertext
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.
Contact typecontact_typetext
The Contact Type for this Organization. You can only use existing Contact Type.
User defined IDentifieruser_defined_identifiertext
A unique key that you can use to identify this Organization.
Restriction levelrestriction_leveltext
The privacy level for this Organization. Public Organization can be managed by anyone in the firm 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. Hidden Organization are only be visible to and managed by the [Client Team](https://help.karbonhq.com/en/articles/1524707-create-a-client-team). SeOne of: Public, Private, Hidden.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "@odata.context": "example",
    "@odata.type": "example",
    "AccountingDetail": "example",
    "ClientManager": "example",
    "ClientOwner": "example",
    "ContactType": "example",
    "EntityDescription": {
      "Text": "example"
    },
    "FullName": "example",
    "LastModifiedDateTime": "example",
    "OrganizationKey": "example",
    "RestrictionLevel": "Public",
    "UserDefinedIdentifier": "example"
  }
}

Update work item

Update work item.

Inputs

Work item keywork_item_keytextRequired
Work item key.
Titletitletext
The title of the Work Item. Must be non-empty and no longer than 200 characters when included.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

On this page