Skip to content
/
FileData

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

ExternalCostData

idstringrequired
titlestringrequired
typestringrequired
indentintegerrequired
orderintegerrequired
is_creditbooleanrequired

if true this cost is a credit

is_optionalbooleanrequired
pricenumberrequired
amountnumberrequired
totalnumberrequired
supplierSupplierData (object) or nullrequired
Any of:
supplier.​idstringrequired
supplier.​namestringrequired
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.​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
statusstring or nullrequired
payment_partial_typestring(OfferUnitIntervalType)required
Enum"once""monthly""yearly"
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
created_atstring(date-time)required
updated_atstring or null(date-time)required
{
  "id": "string",
  "title": "string",
  "type": "string",
  "indent": 0,
  "order": 0,
  "is_credit": true,
  "is_optional": true,
  "price": 0,
  "amount": 0,
  "total": 0,
  "supplier": {
    "id": "string",
    "name": "string"
  },
  "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": { … }
  },
  "status": "string",
  "payment_partial_type": "once",
  "payment_partial_interval": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

FileData

idstringrequired
file_namestringrequired
mime_typestringrequired
sizeintegerrequired

File size in bytes

entity_idstringrequired

ID of the entity that the file belongs to

entity_typestringrequired

Type of the entity that the file belongs to

created_atstringrequired
{
  "id": "string",
  "file_name": "string",
  "mime_type": "string",
  "size": 0,
  "entity_id": "string",
  "entity_type": "string",
  "created_at": "string"
}

IntegrationData

slugstringrequired
granted_scopesArray of stringsrequired
{
  "slug": "string",
  "granted_scopes": [
    "string"
  ]
}