Skip to content
/
MilestoneData

Kanbert (v1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
https://api.kanbert.com/api/v1

Users

Operations

Clients

Operations

Projects

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Payments

Operations

Usergroups & Teams

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

Schemas

MetricData

idstringrequired
titlestringrequired
title_pluralstringrequired
{
  "id": "string",
  "title": "string",
  "title_plural": "string"
}

MilestoneData

idstringrequired
titlestringrequired
po_numberstring or nullrequired
groupPhaseGroupData (object) or nullrequired
Any of:
group.​idstringrequired
group.​titlestringrequired
dependency_phase_idstring or nullrequired
dependency_milestone_idstring or nullrequired
datestring(date)required
created_atstring or null(date-time)required
computed_fieldsobject
{
  "id": "string",
  "title": "string",
  "po_number": "string",
  "group": {
    "id": "string",
    "title": "string"
  },
  "dependency_phase_id": "string",
  "dependency_milestone_id": "string",
  "date": "2019-08-24",
  "created_at": "2019-08-24T14:15:22Z",
  "computed_fields": {
    "property1": 0,
    "property2": 0
  }
}

OfferData

idstringrequired
offer_numberstring or nullrequired
titlestringrequired
statusstring(OfferStatus)required
open
Offer in draft
approval_pending
Offer was submitted for internal approval
approval_approved
Offer was internally approved
transformed
Customer approved offer
cancelled
Customer declined offer
Enum"open""approval_pending""approval_approved""transformed""cancelled"
approvals_neededinteger or nullrequired
is_direct_approvedboolean or nullrequired

Offer skipped internal approval process - can also be true if offer is still open, due to reopening

date_of_offerstring(date-time)required
date_of_expirystring(date-time)required
performance_range_startstring(date-time)required
performance_range_endstring(date-time)required
localestringrequired
currencystringrequired
addressstringrequired
address_changedbooleanrequired

If true the user manually overwrote the companies address

companyCompanyData (object) or nullrequired
Any of:
company.​idstringrequired
company.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

company.​external_originstring or nullrequired

If originated from external system origin is added

company.​vendor_identifierstring or nullrequired
company.​company_namestring or nullrequired
company.​localestring or nullrequired
company.​tax_uidstring or nullrequired
company.​taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

company.​ibanstring or nullrequired
company.​bicstring or nullrequired
company.​emailstring or nullrequired
company.​email_generalstring or nullrequired
company.​phonestring or nullrequired
company.​faxstring or nullrequired
company.​homepagestring or nullrequired
company.​invoices_by_postbooleanrequired
Default false
company.​invoices_by_emailbooleanrequired
Default false
company.​business_fieldBusinessFieldData (object) or nullrequired
Any of:
company.​business_field.​idstringrequired
company.​business_field.​namestringrequired
company.​company_sizeTagData (object) or nullrequired
Any of:
company.​company_size.​idstringrequired
company.​company_size.​titlestringrequired
company.​company_revenueTagData (object) or nullrequired
Any of:
company.​company_revenue.​idstringrequired
company.​company_revenue.​titlestringrequired
company.​person_attention_tostring or nullrequired
company.​address_invoice_titlestring or nullrequired
company.​address_invoice_streetstring or nullrequired
company.​address_invoice_housestring or nullrequired
company.​address_invoice_street2string or nullrequired
company.​address_invoice_zipstring or nullrequired
company.​address_invoice_statestring or nullrequired
company.​address_invoice_townstring or nullrequired
company.​address_invoice_countryCountryData (object) or nullrequired
Any of:
company.​address_invoice_country.​idstringrequired
company.​address_invoice_country.​namestringrequired
company.​address_invoice_country.​codestring(ISO 3166-1 alpha-2)required
company.​address_invoice_is_deliverybooleanrequired
company.​delivery_person_attention_tostring or nullrequired
company.​address_delivery_titlestring or nullrequired
company.​address_delivery_streetstring or nullrequired
company.​address_delivery_housestring or nullrequired
company.​address_delivery_street2string or nullrequired
company.​address_delivery_zipstring or nullrequired
company.​address_delivery_statestring or nullrequired
company.​address_delivery_townstring or nullrequired
company.​address_delivery_countryCountryData (object) or nullrequired
Any of:
company.​address_delivery_country.​idstringrequired
company.​address_delivery_country.​namestringrequired
company.​address_delivery_country.​codestring(ISO 3166-1 alpha-2)required
company.​clientClientData (object) or nullrequired
Any of:
company.​client.​idstringrequired
company.​client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

company.​client.​external_originstring or nullrequired

If originated from external system origin is added

company.​client.​namestringrequired
company.​client.​shortcodestring or nullrequired
company.​client.​primary_contactUserData (object) or nullrequired
Any of:
company.​client.​primary_contact.​idstringrequired
company.​client.​primary_contact.​first_namestringrequired
company.​client.​primary_contact.​last_namestringrequired
company.​client.​primary_contact.​emailstringrequired
company.​client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
company.​client.​primary_contact.​spaceobject(SpaceData)required
company.​client.​primary_contact.​space.​idstringrequired
company.​client.​primary_contact.​space.​namestringrequired
company.​client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

company.​client.​origin_space.​idstringrequired
company.​client.​origin_space.​namestringrequired
company.​tagsArray of objects(TagData)
company.​contactsArray of objects(ContactData)
company.​custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

company.​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
company.​created_atstring(date-time)required
company.​updated_atstring or null(date-time)required
company.​deleted_atstring or null(date-time)required
company.​contact_companyobject(ContactCompanyPivotData)

Added included via relationship (contact -> companies or company -> contacts)

editorUserData (object) or nullrequired
Any of:
editor.​idstringrequired
editor.​first_namestringrequired
editor.​last_namestringrequired
editor.​emailstringrequired
editor.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
editor.​spaceobject(SpaceData)required
editor.​space.​idstringrequired
editor.​space.​namestringrequired
clientobject(ClientData)required
client.​idstringrequired
client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

client.​external_originstring or nullrequired

If originated from external system origin is added

client.​namestringrequired
client.​shortcodestring or nullrequired
client.​primary_contactUserData (object) or nullrequired
Any of:
client.​primary_contact.​idstringrequired
client.​primary_contact.​first_namestringrequired
client.​primary_contact.​last_namestringrequired
client.​primary_contact.​emailstringrequired
client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
client.​primary_contact.​spaceobject(SpaceData)required
client.​primary_contact.​space.​idstringrequired
client.​primary_contact.​space.​namestringrequired
client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

client.​origin_space.​idstringrequired
client.​origin_space.​namestringrequired
projectProjectData (object) or nullrequired
Any of:
project.​idstringrequired
project.​external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

project.​external_originstring or nullrequired

If originated from external system origin is added

project.​titlestringrequired
project.​shortcodestringrequired
project.​po_numberstring or nullrequired
project.​project_typeobject(ProjectTypeData)required
project.​project_type.​idstringrequired
project.​project_type.​titlestringrequired
project.​project_type.​shortcodestringrequired
project.​project_type.​colorstringrequired
project.​project_type.​orderintegerrequired
project.​project_type.​is_defaultbooleanrequired
project.​statusstringrequired
project.​is_acquisitionbooleanrequired
project.​is_privatebooleanrequired
project.​start_datestring or null(date)required
project.​end_datestring or null(date)required
project.​clientobject(ClientData)required
project.​client.​idstringrequired
project.​client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

project.​client.​external_originstring or nullrequired

If originated from external system origin is added

project.​client.​namestringrequired
project.​client.​shortcodestring or nullrequired
project.​client.​primary_contactUserData (object) or nullrequired
Any of:
project.​client.​primary_contact.​idstringrequired
project.​client.​primary_contact.​first_namestringrequired
project.​client.​primary_contact.​last_namestringrequired
project.​client.​primary_contact.​emailstringrequired
project.​client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
project.​client.​primary_contact.​spaceobject(SpaceData)required
project.​client.​primary_contact.​space.​idstringrequired
project.​client.​primary_contact.​space.​namestringrequired
project.​client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

project.​client.​origin_space.​idstringrequired
project.​client.​origin_space.​namestringrequired
project.​tagsArray of objects(ProjectTagData)
project.​custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

project.​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
project.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the project is shared from, if null project is not shared

project.​origin_space.​idstringrequired
project.​origin_space.​namestringrequired
project.​teamArray of objects(TeamMemberData)

Project team

project.​guestsArray of objects(TeamMemberData)

Project guests

project.​computed_fieldsobject
taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

sum_netnumberrequired
sum_taxnumberrequired
sum_grossnumberrequired
sum_external_costsnumberrequired
line_itemsArray of objects(OfferLineItemData)required
line_items[].​idstringrequired
line_items[].​titlestringrequired
line_items[].​typestring(AccountingLineItemType)required
Enum"unit""category""page_break"
line_items[].​indentintegerrequired
line_items[].​orderintegerrequired
line_items[].​is_optionalbooleanrequired
line_items[].​pricenumberrequired
line_items[].​amountnumberrequired
line_items[].​total_net_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

line_items[].​total_netnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

line_items[].​total_gross_basenumberrequired

Excluding all discounts
Does not reflect total value over performance range

line_items[].​tax_factornumberrequired
line_items[].​total_grossnumberrequired

Including unit discount (not offer discounts)
Does not reflect total value over performance range

line_items[].​metricobject(MetricData)required
line_items[].​metric.​idstringrequired
line_items[].​metric.​titlestringrequired
line_items[].​metric.​title_pluralstringrequired
line_items[].​projectProjectData (object) or nullrequired
Any of:
line_items[].​project.​idstringrequired
line_items[].​project.​external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

line_items[].​project.​external_originstring or nullrequired

If originated from external system origin is added

line_items[].​project.​titlestringrequired
line_items[].​project.​shortcodestringrequired
line_items[].​project.​po_numberstring or nullrequired
line_items[].​project.​project_typeobject(ProjectTypeData)required
line_items[].​project.​project_type.​idstringrequired
line_items[].​project.​project_type.​titlestringrequired
line_items[].​project.​project_type.​shortcodestringrequired
line_items[].​project.​project_type.​colorstringrequired
line_items[].​project.​project_type.​orderintegerrequired
line_items[].​project.​project_type.​is_defaultbooleanrequired
line_items[].​project.​statusstringrequired
line_items[].​project.​is_acquisitionbooleanrequired
line_items[].​project.​is_privatebooleanrequired
line_items[].​project.​start_datestring or null(date)required
line_items[].​project.​end_datestring or null(date)required
line_items[].​project.​clientobject(ClientData)required
line_items[].​project.​client.​idstringrequired
line_items[].​project.​client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

line_items[].​project.​client.​external_originstring or nullrequired

If originated from external system origin is added

line_items[].​project.​client.​namestringrequired
line_items[].​project.​client.​shortcodestring or nullrequired
line_items[].​project.​client.​primary_contactUserData (object) or nullrequired
Any of:
line_items[].​project.​client.​primary_contact.​idstringrequired
line_items[].​project.​client.​primary_contact.​first_namestringrequired
line_items[].​project.​client.​primary_contact.​last_namestringrequired
line_items[].​project.​client.​primary_contact.​emailstringrequired
line_items[].​project.​client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
line_items[].​project.​client.​primary_contact.​spaceobject(SpaceData)required
line_items[].​project.​client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

line_items[].​project.​client.​origin_space.​idstringrequired
line_items[].​project.​client.​origin_space.​namestringrequired
line_items[].​project.​tagsArray of objects(ProjectTagData)
line_items[].​project.​custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

line_items[].​project.​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
line_items[].​project.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the project is shared from, if null project is not shared

line_items[].​project.​origin_space.​idstringrequired
line_items[].​project.​origin_space.​namestringrequired
line_items[].​project.​teamArray of objects(TeamMemberData)

Project team

line_items[].​project.​guestsArray of objects(TeamMemberData)

Project guests

line_items[].​project.​computed_fieldsobject
line_items[].​exclude_from_discountbooleanrequired

If true, the unit will be excluded from offer-wide discounts

Default false
line_items[].​discount_factornumber or nullrequired
line_items[].​discount_absolutenumber or nullrequired
line_items[].​discount_boundbooleanrequired

If true, the amount will multiply discount absolute

Default false
line_items[].​purchase_pricenumberrequired
Default 0
line_items[].​purchase_amountnumberrequired
Default 1
line_items[].​purchase_totalnumberrequired
Default 0
line_items[].​purchase_price_boundbooleanrequired

If true, purchase_amount will be in sync with amount

Default false
line_items[].​descriptionstringrequired
line_items[].​payment_partial_typestring(OfferUnitIntervalType)required
Enum"once""monthly""yearly"
line_items[].​payment_partial_intervalinteger or nullrequired

Interval if payment partial type is monthly or `yearly

TypeIntervalDescription
onceanyOnce per offer
monthly1Every month in performance range
monthly3Every 3 months in performance range
monthly6Every 6 monthsin performance range
yearly1Every year in performance range
yearly3Every 3 years in performance range
yearly6Every 6 years in performance range
external_costsArray of objects(ExternalCostData)required
external_costs[].​idstringrequired
external_costs[].​titlestringrequired
external_costs[].​typestringrequired
external_costs[].​indentintegerrequired
external_costs[].​orderintegerrequired
external_costs[].​is_creditbooleanrequired

if true this cost is a credit

external_costs[].​is_optionalbooleanrequired
external_costs[].​pricenumberrequired
external_costs[].​amountnumberrequired
external_costs[].​totalnumberrequired
external_costs[].​supplierSupplierData (object) or nullrequired
Any of:
external_costs[].​supplier.​idstringrequired
external_costs[].​supplier.​namestringrequired
external_costs[].​clientClientData (object) or nullrequired
Any of:
external_costs[].​client.​idstringrequired
external_costs[].​client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

external_costs[].​client.​external_originstring or nullrequired

If originated from external system origin is added

external_costs[].​client.​namestringrequired
external_costs[].​client.​shortcodestring or nullrequired
external_costs[].​client.​primary_contactUserData (object) or nullrequired
Any of:
external_costs[].​client.​primary_contact.​idstringrequired
external_costs[].​client.​primary_contact.​first_namestringrequired
external_costs[].​client.​primary_contact.​last_namestringrequired
external_costs[].​client.​primary_contact.​emailstringrequired
external_costs[].​client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
external_costs[].​client.​primary_contact.​spaceobject(SpaceData)required
external_costs[].​client.​primary_contact.​space.​idstringrequired
external_costs[].​client.​primary_contact.​space.​namestringrequired
external_costs[].​client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

external_costs[].​client.​origin_space.​idstringrequired
external_costs[].​client.​origin_space.​namestringrequired
external_costs[].​projectProjectData (object) or nullrequired
Any of:
external_costs[].​project.​idstringrequired
external_costs[].​project.​external_idstring or nullrequired

Can be used to add an identifier to the project from an external system, must be unique

external_costs[].​project.​external_originstring or nullrequired

If originated from external system origin is added

external_costs[].​project.​titlestringrequired
external_costs[].​project.​shortcodestringrequired
external_costs[].​project.​po_numberstring or nullrequired
external_costs[].​project.​project_typeobject(ProjectTypeData)required
external_costs[].​project.​project_type.​idstringrequired
external_costs[].​project.​project_type.​titlestringrequired
external_costs[].​project.​project_type.​shortcodestringrequired
external_costs[].​project.​project_type.​colorstringrequired
external_costs[].​project.​project_type.​orderintegerrequired
external_costs[].​project.​project_type.​is_defaultbooleanrequired
external_costs[].​project.​statusstringrequired
external_costs[].​project.​is_acquisitionbooleanrequired
external_costs[].​project.​is_privatebooleanrequired
external_costs[].​project.​start_datestring or null(date)required
external_costs[].​project.​end_datestring or null(date)required
external_costs[].​project.​clientobject(ClientData)required
external_costs[].​project.​client.​idstringrequired
external_costs[].​project.​client.​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

external_costs[].​project.​client.​external_originstring or nullrequired

If originated from external system origin is added

external_costs[].​project.​client.​namestringrequired
external_costs[].​project.​client.​shortcodestring or nullrequired
external_costs[].​project.​client.​primary_contactUserData (object) or nullrequired
Any of:
external_costs[].​project.​client.​primary_contact.​idstringrequired
external_costs[].​project.​client.​primary_contact.​first_namestringrequired
external_costs[].​project.​client.​primary_contact.​last_namestringrequired
external_costs[].​project.​client.​primary_contact.​emailstringrequired
external_costs[].​project.​client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
external_costs[].​project.​client.​primary_contact.​spaceobject(SpaceData)required
external_costs[].​project.​client.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

external_costs[].​project.​client.​origin_space.​idstringrequired
external_costs[].​project.​client.​origin_space.​namestringrequired
external_costs[].​project.​tagsArray of objects(ProjectTagData)
external_costs[].​project.​custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

external_costs[].​project.​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
external_costs[].​project.​origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the project is shared from, if null project is not shared

external_costs[].​project.​origin_space.​idstringrequired
external_costs[].​project.​origin_space.​namestringrequired
external_costs[].​project.​teamArray of objects(TeamMemberData)

Project team

external_costs[].​project.​guestsArray of objects(TeamMemberData)

Project guests

external_costs[].​project.​computed_fieldsobject
external_costs[].​statusstring or nullrequired
external_costs[].​payment_partial_typestring(OfferUnitIntervalType)required
Enum"once""monthly""yearly"
external_costs[].​payment_partial_intervalinteger or nullrequired

Interval if payment partial type is monthly or `yearly

TypeIntervalDescription
onceanyOnce per offer
monthly1Every month in performance range
monthly3Every 3 months in performance range
monthly6Every 6 monthsin performance range
yearly1Every year in performance range
yearly3Every 3 years in performance range
yearly6Every 6 years in performance range
external_costs[].​created_atstring(date-time)required
external_costs[].​updated_atstring or null(date-time)required
created_atstring(date-time)required
updated_atstring or null(date-time)required
deleted_atstring or null(date-time)required
computed_fieldsobject
{
  "id": "string",
  "offer_number": "string",
  "title": "string",
  "status": "open",
  "approvals_needed": 0,
  "is_direct_approved": true,
  "date_of_offer": "2019-08-24T14:15:22Z",
  "date_of_expiry": "2019-08-24T14:15:22Z",
  "performance_range_start": "2019-08-24T14:15:22Z",
  "performance_range_end": "2019-08-24T14:15:22Z",
  "locale": "string",
  "currency": "string",
  "address": "string",
  "address_changed": true,
  "company": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation_enabled": true,
    "iban": "string",
    "bic": "string",
    "email": "string",
    "email_general": "string",
    "phone": "string",
    "fax": "string",
    "homepage": "string",
    "invoices_by_post": false,
    "invoices_by_email": false,
    "business_field": { … },
    "company_size": { … },
    "company_revenue": { … },
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_house": "string",
    "address_invoice_street2": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_country": { … },
    "address_invoice_is_delivery": true,
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_house": "string",
    "address_delivery_street2": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": { … },
    "client": { … },
    "tags": [ … ],
    "contacts": [ … ],
    "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "contact_company": { … }
  },
  "editor": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "project": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "title": "string",
    "shortcode": "string",
    "po_number": "string",
    "project_type": { … },
    "status": "string",
    "is_acquisition": true,
    "is_private": true,
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "client": { … },
    "tags": [ … ],
    "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
    "origin_space": { … },
    "team": [ … ],
    "guests": [ … ],
    "computed_fields": { … }
  },
  "taxation_enabled": true,
  "sum_net": 0,
  "sum_tax": 0,
  "sum_gross": 0,
  "sum_external_costs": 0,
  "line_items": [
    { … }
  ],
  "external_costs": [
    { … }
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "computed_fields": {
    "property1": 0,
    "property2": 0
  }
}