# Karbon

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/karbon

## Actions

### Create client group

Create client group.

**Inputs**

- Full name (`full_name`, text, required): The full name of the Client Group
- Client owner (`client_owner`, text): 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 manager (`client_manager`, text): 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 type (`contact_type`, text): The Contact Type for this Client Group. You can only use existing Contact Type.
- User defined IDentifier (`user_defined_identifier`, text): A unique key that you can use to identify this Client Group.
- Restriction level (`restriction_level`, text): 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 contact (`primary_contact`, text): The main contact for a client with multiple contact details.
- Entity description (`entity_description`, object): Entity description.
- Members (`members`, list): The members of the Client Group
- Accounting details (`accounting_details`, text): The accounting details associated with the Client Group. This property will be `null`.
- Business card (`business_card`, object): A business card associated with a contact or organization
- Client team (`client_team`, list): The Client Team associated with a contact or organization

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 name (`first_name`, text, required): The first name of the Contact
- Middle name (`middle_name`, text): The middle name of the Contact
- Last name (`last_name`, text, required): The last name of the Contact
- Preferred name (`preferred_name`, text): The preferred name of the Contact
- Salutation (`salutation`, text): The title to address the Contact
- Suffix (`suffix`, text): The suffix of the Contact
- Restriction level (`restriction_level`, text): 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` requires. One of: `Public`, `Private`, `Hidden`. Default: `Public`.
- Client owner (`client_owner`, text): 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 manager (`client_manager`, text): 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 type (`contact_type`, text): The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint.
- User defined IDentifier (`user_defined_identifier`, text): A unique key that you can use to identify this Contact.
- Business cards (`business_cards`, list): Business cards.
- Entity description (`entity_description`, object): Entity description.
- Accounting detail (`accounting_detail`, object): The details specific to the Accounting firm related to this entity
- Client team (`client_team`, list): The Client Team associated with a contact or organization

**Outputs**

- `data` (object): A single Contact

**Example output**

```json
{
  "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 name (`full_name`, text, required): The full name of the Organization
- Client owner (`client_owner`, text): 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 manager (`client_manager`, text): 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 type (`contact_type`, text): The Contact Type for this Organization. You can only use existing Contact Type.
- User defined IDentifier (`user_defined_identifier`, text): A unique key that you can use to identify this Organization.
- Restriction level (`restriction_level`, text): 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). Se. One of: `Public`, `Private`, `Hidden`. Default: `Public`.
- Business cards (`business_cards`, list): Business cards.
- Entity description (`entity_description`, object): Entity description.
- Accounting detail (`accounting_detail`, object): The details specific to the Accounting firm related to this entity
- Client team (`client_team`, list): The Client Team associated with a contact or organization

**Outputs**

- `data` (object): A single Organization

**Example output**

```json
{
  "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 address (`assignee_email_address`, text, required): The email address of the user to whom the Work Item has been assigned
- Title (`title`, text, required): The title of the Work Item
- Client key (`client_key`, text, required): A Karbon-generated value used to identify the Client for whom the Work Item is prepared
- Client type (`client_type`, text, required): The type of the Client. One of: `Contact`, `Organization`, `ClientGroup`.
- Related client group key (`related_client_group_key`, text): A Karbon-generated value used to identify the Client Group of the Client
- Start date (`start_date`, date and time, required): The date and time at which the Work Item should start
- Due date (`due_date`, date and time): The date and time by which the Work Item should be complete
- Deadline date (`deadline_date`, date and time): The date and time by which an external party has specified that the Work Item should be complete
- Work type (`work_type`, text): The type of work related to the Work Item. Enter an existing Work Type.
- Work status (`work_status`, text): The current status of the Work Item
- Primary status (`primary_status`, text): 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 status (`secondary_status`, text): The current child-level Status of the Work Item
- Work template key (`work_template_key`, text): A Karbon-generated value used to identify the Template that will be used to generate this Work Item
- Work schedule key (`work_schedule_key`, text): A Karbon-generated value used to identify the Work Schedule for this Work Item
- Estimated budget (`estimated_budget`, number): The estimated budget for the Work Item
- Description (`description`, text): A free form text field to add more information about the Work Item
- Client task recipient (`client_task_recipient`, object): The details about the recipient of the Client Tasks related to this Work Item.
- Fee settings (`fee_settings`, object): 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 assignments (`user_role_assignments`, list): The array that describes the roles of the users associated with this Work Item.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 groupkey (`client_groupkey`, text, required): Client groupkey.
- Expand (`expand`, text): Expand.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Contactkey (`contactkey`, text, required): Contactkey.
- Expand (`expand`, text): Expand. One of: `BusinessCards`, `ClientTeam`, `ClientAccess`, `ServiceTypes`.

**Outputs**

- `data` (object): A single Contact

**Example output**

```json
{
  "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 key (`invoice_key`, text, required): Invoice key.
- Expand (`expand`, text): Expand. One of: `LineItems`, `Payments`, `Data`, `LineItems,Data`, `LineItems,Payments`, `LineItems,Payments,Data`, `Payments,Data`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Organizationkey (`organizationkey`, text, required): Organizationkey.
- Expand (`expand`, text): Expand.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- `data` (object): A collection of customer specific Contact and Work settings

**Example output**

```json
{
  "data": {
    "ClientAccessActivated": false,
    "ContactTypes": [],
    "FilingDeadlines": [],
    "ServiceTypes": [],
    "TenantKey": "example",
    "WorkStatuses": [],
    "WorkTypes": []
  }
}
```

### Get work item

Get work item.

**Inputs**

- Work item key (`work_item_key`, text, required): Work item key.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby. Default: `ClientGroupKey`.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A list of Client Groups

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### List contacts

List contacts.

**Inputs**

- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby. One of: `FullName`, `FullName desc`, `LastModifiedDateTime`, `LastModifiedDateTime desc`.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A list of Contacts

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### List invoices

List invoices.

**Inputs**

- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.
- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "value": []
  }
}
```

### List organizations

List organizations.

**Inputs**

- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby. One of: `FullName`, `FullName desc`, `LastModifiedDateTime`, `LastModifiedDateTime desc`.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A list of Organizations

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### List users

List users.

**Inputs**

- Filter (`filter`, text): Filter.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A collection of Users

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### List work items

List work items.

**Inputs**

- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby. One of: `StartDate`, `StartDate desc`, `DeadlineDate`, `DeadlineDate desc`.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A collection of work items

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### List work templates

List work templates.

**Inputs**

- Filter (`filter`, text): Filter.
- Orderby (`orderby`, text): Orderby. One of: `WorkTypeKey`, `WorkTypeKey desc`, `PublishedDate`, `PublishedDate desc`, `NumberOfWorkItemsCreated`, `NumberOfWorkItemsCreated desc`, `DateLastWorkItemCreated`, `DateLastWorkItemCreated desc`, `DateModified`, `DateModified desc`. Default: `WorkTypeKey`.
- Skip (`skip`, number): Skip. From 0 to 100.
- Top (`top`, number): Top. At least 0.

**Outputs**

- `data` (object): A collection of Work Templates

**Example output**

```json
{
  "data": {
    "@odata.context": "example",
    "@odata.count": 1,
    "@odata.nextLink": "example",
    "value": []
  }
}
```

### Update contact

Update contact.

**Inputs**

- Contactkey (`contactkey`, text, required): Contactkey.
- First name (`first_name`, text): The first name of the Contact
- Middle name (`middle_name`, text): The middle name of the Contact
- Last name (`last_name`, text): The last name of the Contact
- Preferred name (`preferred_name`, text): The preferred name of the Contact
- Salutation (`salutation`, text): The title to address the Contact
- Suffix (`suffix`, text): The suffix of the Contact
- Client owner (`client_owner`, text): 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 manager (`client_manager`, text): 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 type (`contact_type`, text): The Contact Type for this Contact. You can only use existing Contact Types, these are available from the TenantSettings endpoint.
- User defined IDentifier (`user_defined_identifier`, text): A unique key that you can use to identify this Contact.
- Restriction level (`restriction_level`, text): 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` requires. One of: `Public`, `Private`, `Hidden`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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**

- Organizationkey (`organizationkey`, text, required): Organizationkey.
- Prefer (`prefer`, text): Prefer.
- Full name (`full_name`, text): The full name of the Organization
- Client owner (`client_owner`, text): 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 manager (`client_manager`, text): 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 type (`contact_type`, text): The Contact Type for this Organization. You can only use existing Contact Type.
- User defined IDentifier (`user_defined_identifier`, text): A unique key that you can use to identify this Organization.
- Restriction level (`restriction_level`, text): 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). Se. One of: `Public`, `Private`, `Hidden`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 key (`work_item_key`, text, required): Work item key.
- Title (`title`, text): The title of the Work Item. Must be non-empty and no longer than 200 characters when included.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```
