Skip to content
/
ClientFullData

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

ClientData

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"
  }
}

ClientFullData

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
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
updated_atstring(date-time)required
created_atstring(date-time)required
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
projectsArray of objects(ProjectData)
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",
  "segment": "A",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "projects": [
    { … }
  ],
  "origin_space": {
    "id": "string",
    "name": "string"
  }
}

ClientSegment

string(ClientSegment)
Enum"A""B""C"
"A"