Skip to content
Download OpenAPI description
Languages
Servers
https://api.kanbert.com/api/v1
Operations
Operations
Operations
Operations
Operations
Webhooks
Operations
Webhooks
Operations
Operations
Webhooks
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Schemas
idstringrequired
typestringrequired
titlestring or nullrequired
valuenumberrequired
clientClientData (object) or nullrequired
Any of:
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.​descriptionstring or nullrequired
project.​shortcodestringrequired
project.​po_numberstring or nullrequired
project.​project_typeProjectTypeData (object) or nullrequired
Any of:
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.​project_groupProjectGroupData (object) or nullrequired
Any of:
project.​project_group.​idstringrequired
project.​project_group.​titlestringrequired
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.​portfoliosArray of objects(ProjectPortfolioData)
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
chart_of_accountChartOfAccountData (object) or object or nullrequired
Any of:
chart_of_account.​idstringrequired
chart_of_account.​typeCostCenterType (string) or nullrequired
Any of:
string(CostCenterType)
Enum"accounts""discount""supplier_discount"
chart_of_account.​codestring or nullrequired
chart_of_account.​titlestring or nullrequired
chart_of_account.​descriptionstring or nullrequired
chart_of_account.​prioritystring or nullrequired
chart_of_account.​budgetsobject or nullrequired
chart_of_account.​budgets.​property name*numberadditional property
chart_of_account.​start_datestring or null(date-time)required
chart_of_account.​end_datestring or null(date-time)required
chart_of_account.​created_atstring(date-time)required
chart_of_account.​updated_atstring or null(date-time)required
chart_of_account.​positionsArray of PositionData (objects) or object
Any of:
positionPositionData (object) or object or nullrequired
Any of:
position.​idstringrequired
position.​titlestring or nullrequired
position.​planobject or nullrequired
position.​plan.​property name*numberadditional property
position.​start_datestring or null(date-time)required
position.​end_datestring or null(date-time)required
position.​created_atstring(date-time)required
position.​updated_atstring or null(date-time)required
incoming_invoiceChartOfAccountsBookingDocumentData (object) or object or null
Any of:
outgoing_invoiceOutgoingInvoiceReferenceData (object) or nullrequired
Any of:
outgoing_invoice.​idstringrequired
outgoing_invoice.​invoice_numberstring or nullrequired
outgoing_invoice.​titlestringrequired
outgoing_invoice.​is_creditbooleanrequired
created_atstring(date-time)required
updated_atstring or null(date-time)required
{ "id": "string", "type": "string", "title": "string", "value": 0, "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", "description": "string", "shortcode": "string", "po_number": "string", "project_type": {}, "project_group": {}, "status": "string", "is_acquisition": true, "is_private": true, "start_date": "2019-08-24", "end_date": "2019-08-24", "client": {}, "tags": [], "portfolios": [], "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]", "origin_space": {}, "team": [], "guests": [], "computed_fields": {} }, "chart_of_account": { "id": "string", "type": "accounts", "code": "string", "title": "string", "description": "string", "priority": "string", "budgets": {}, "start_date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "positions": [] }, "position": { "id": "string", "title": "string", "plan": {}, "start_date": "2019-08-24T14:15:22Z", "end_date": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "incoming_invoice": { "id": "string", "title": "string", "type": "string", "invoice_number": "string" }, "outgoing_invoice": { "id": "string", "invoice_number": "string", "title": "string", "is_credit": true }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }

ChartOfAccountsBookingDocumentData

idstringrequired
titlestring or nullrequired
typestring or nullrequired
invoice_numberstring or nullrequired
{ "id": "string", "title": "string", "type": "string", "invoice_number": "string" }
idstringrequired
external_idstring or nullrequired

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

external_originstring or nullrequired

If originated from external system origin is added

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

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

origin_space.​idstringrequired
origin_space.​namestringrequired
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": {} }, "origin_space": { "id": "string", "name": "string" } }