Karbon
App · 20 actions
Manage accounting clients, work items and client groups; read invoices, users and work templates.
Actions
| Action | What it does |
|---|---|
| Create client group | Create client group. |
| Create contact | Create contact. |
| Create organization | Create organization. |
| Create work item | Create work item. |
| Get client group | Get client group. |
| Get contact | Get contact. |
| Get invoice | Get invoice. |
| Get organization | Get organization. |
| Get tenant settings | Get tenant settings. |
| Get work item | Get work item. |
| List client groups | List client groups. |
| List contacts | List contacts. |
| List invoices | List invoices. |
| List organizations | List organizations. |
| List users | List users. |
| List work items | List work items. |
| List work templates | List work templates. |
| Update contact | Update contact. |
| Update organization | Update organization. |
| Update work item | Update work item. |
Create client group
Create client group.
Inputs
- Full name
full_nametextRequired - The full name of the Client Group
- Client owner
client_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 manager
client_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 type
contact_typetext - The Contact Type for this Client Group. You can only use existing Contact Type.
- User defined IDentifier
user_defined_identifiertext - A unique key that you can use to identify this Client Group.
- Restriction level
restriction_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 contact
primary_contacttext - The main contact for a client with multiple contact details.
- Entity description
entity_descriptionobject - Entity description.
- Members
memberslist - The members of the Client Group
- Accounting details
accounting_detailstext - The accounting details associated with the Client Group. This property will be `null`.
- Business card
business_cardobject - A business card associated with a contact or organization
- Client team
client_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 name
first_nametextRequired - The first name of the Contact
- Middle name
middle_nametext - The middle name of the Contact
- Last name
last_nametextRequired - The last name of the Contact
- Preferred name
preferred_nametext - The preferred name of the Contact
- Salutation
salutationtext - The title to address the Contact
- Suffix
suffixtext - The suffix of the Contact
- Restriction level
restriction_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 owner
client_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 manager
client_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 type
contact_typetext - 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_identifiertext - A unique key that you can use to identify this Contact.
- Business cards
business_cardslist - Business cards.
- Entity description
entity_descriptionobject - Entity description.
- Accounting detail
accounting_detailobject - The details specific to the Accounting firm related to this entity
- Client team
client_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 name
full_nametextRequired - The full name of the Organization
- Client owner
client_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 manager
client_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 type
contact_typetext - The Contact Type for this Organization. You can only use existing Contact Type.
- User defined IDentifier
user_defined_identifiertext - A unique key that you can use to identify this Organization.
- Restriction level
restriction_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 cards
business_cardslist - Business cards.
- Entity description
entity_descriptionobject - Entity description.
- Accounting detail
accounting_detailobject - The details specific to the Accounting firm related to this entity
- Client team
client_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 address
assignee_email_addresstextRequired - The email address of the user to whom the Work Item has been assigned
- Title
titletextRequired - The title of the Work Item
- Client key
client_keytextRequired - A Karbon-generated value used to identify the Client for whom the Work Item is prepared
- Client type
client_typetextRequired - The type of the ClientOne of:
Contact,Organization,ClientGroup. - Related client group key
related_client_group_keytext - A Karbon-generated value used to identify the Client Group of the Client
- Start date
start_datedate and timeRequired - The date and time at which the Work Item should start
- Due date
due_datedate and time - The date and time by which the Work Item should be complete
- Deadline date
deadline_datedate and time - The date and time by which an external party has specified that the Work Item should be complete
- Work type
work_typetext - The type of work related to the Work Item. Enter an existing Work Type.
- Work status
work_statustext - The current status of the Work Item
- Primary status
primary_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 status
secondary_statustext - The current child-level Status of the Work Item
- Work template key
work_template_keytext - A Karbon-generated value used to identify the Template that will be used to generate this Work Item
- Work schedule key
work_schedule_keytext - A Karbon-generated value used to identify the Work Schedule for this Work Item
- Estimated budget
estimated_budgetnumber - The estimated budget for the Work Item
- Description
descriptiontext - A free form text field to add more information about the Work Item
- Client task recipient
client_task_recipientobject - The details about the recipient of the Client Tasks related to this Work Item.
- Fee settings
fee_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 assignments
user_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 groupkey
client_groupkeytextRequired - Client groupkey.
- Expand
expandtext - 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
- Contactkey
contactkeytextRequired - Contactkey.
- Expand
expandtext - 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 key
invoice_keytextRequired - Invoice key.
- Expand
expandtext - 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
- Organizationkey
organizationkeytextRequired - Organizationkey.
- Expand
expandtext - 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 key
work_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
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.Default:
ClientGroupKey. - Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.One of:
FullName,FullName desc,LastModifiedDateTime,LastModifiedDateTime desc. - Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - Top.At least 0.
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.
Outputs
dataobject- Response.
Example output
{
"data": {
"@odata.context": "example",
"@odata.count": 1,
"value": []
}
}List organizations
List organizations.
Inputs
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.One of:
FullName,FullName desc,LastModifiedDateTime,LastModifiedDateTime desc. - Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Filter
filtertext - Filter.
- Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.One of:
StartDate,StartDate desc,DeadlineDate,DeadlineDate desc. - Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Filter
filtertext - Filter.
- Orderby
orderbytext - Orderby.One of:
WorkTypeKey,WorkTypeKey desc,PublishedDate,PublishedDate desc,NumberOfWorkItemsCreated,NumberOfWorkItemsCreated desc,DateLastWorkItemCreated,DateLastWorkItemCreated desc,DateModified,DateModified desc. Default:WorkTypeKey. - Skip
skipnumber - Skip.From 0 to 100.
- Top
topnumber - 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
- Contactkey
contactkeytextRequired - Contactkey.
- First name
first_nametext - The first name of the Contact
- Middle name
middle_nametext - The middle name of the Contact
- Last name
last_nametext - The last name of the Contact
- Preferred name
preferred_nametext - The preferred name of the Contact
- Salutation
salutationtext - The title to address the Contact
- Suffix
suffixtext - The suffix of the Contact
- Client owner
client_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 manager
client_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 type
contact_typetext - 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_identifiertext - A unique key that you can use to identify this Contact.
- Restriction level
restriction_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
- Organizationkey
organizationkeytextRequired - Organizationkey.
- Prefer
prefertext - Prefer.
- Full name
full_nametext - The full name of the Organization
- Client owner
client_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 manager
client_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 type
contact_typetext - The Contact Type for this Organization. You can only use existing Contact Type.
- User defined IDentifier
user_defined_identifiertext - A unique key that you can use to identify this Organization.
- Restriction level
restriction_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 key
work_item_keytextRequired - Work item key.
- Title
titletext - 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": {}
}