Complex types

Complex types

All complex types are sets, describing objects in Microbizz.

  • All fields in bold are required. If an optional field is omitted and the command operates on existing data, the current value of the field will be preserved.

  • Fields marked with (readonly) are only provided when receiving objects from the API; the fields are ignored when transmitting to the API.

 

address

type

string

Description of the type of address, eg. 'Home' or 'Nearest depot' or whatever

full

string

Formatted address

name

string

 

name2

string

 

address

string

 

address2

string

 

zip

string

 

city

string

 

country

string

 

latitude

float

 

longitude

float

 

anchorbudget

id

number

The Microbizz ID of the anchor budget

userid

number

The Microbizz ID of the user who created/edited this

todoid

number

The ID of the task this budget post refers to

date

date

The date of the post. There are only one budget post pr. task pr. date

anchor

set

The budget values, indexed by the budget post IDs

baselayer

A base layer is a layer that can be selected in a map; it is displayed below any drawings / features. 

layerid

string

The ID in Microbizz

title

string

The name of the base layer

modules

collection[string]

List of modcode where this baselayer should be available

changedate

date

 

changetime

time

 

copyright

string

Copyright message to display on the map

deleted

boolean

Set to 1 if the baselayer has been deleted and should no longer be available

format

string

MIME type of the images, eg 'image/png'

layers

string

A string to pass to the WMS server

order

number

Sort order in the list

projection

string

The projection used, eg. 'epsg:25832' or 'webmercator'

type

string

Set to 'wms' if this is a WMS map; otherwise it is a tile map

url

string

The URL of the WMS server or the tile server

budgetarea

id

number

The ID in Microbizz

title

string

The name of the budget area

budgetpost

postid

number

The Microbizz ID of the post

todoid

number

The ID of the task this budget post refers to

budgetpostid

number

The Microbizz ID of a budget area

date

date

The date of the post. There are only one budget post pr. task pr. budget area pr. date

amount

number

The budget value

changedate

date

The date when this entry was last changed

changetime

time

The time when this entry

createdate

date

When this entry was created

createtime

time

When this entry was created

issum

bool

This is 1 if the todo is a project and the budget value is a sum of the budgets from the subtasks

call

id

number

Call ID in Microbizz

customerid

number

ID of customer attached to this call

customertext

string

Textual representation of the customer (readonly)

personid

number

ID of person attached to this call.

persontext

string

Textual representation of the person. (readonly)

calltext

string

Textual representation of the call target. This is the customer text, the person text or a combination. This can be used to show whom to call. (readonly)

mainnumber

string

If a main number is available to dial, it is provided in this field. (readonly)

directnumber

string

If a direct number is available to dial, it is provided in this field. (readonly)

mobilenumber

string

If a mobile number is available to dial, it is provided in this field. (readonly)

calldate

date

The date when the call is expected to take place.

calltime

time

The time when the call is expected to take place.

note

string

A note regarding the call

qfonend

number

For app: Question form ID on question form to present on ending this call. (readonly)

checkin

id

number

Checkin ID in Microbizz

ischeckedin

boolean

True if the status of this checkin is checked in.

readable

string

Textual representation of the place where the checkin occured.

objecttype

string

The object type on which we logged in. Customer or Todo

toolid

int

If this checkin regarded a tool, then this is the toolid.

userid

int

Reference to user who performed the checkin.

todoid

int

The ID of the task which this checkin regards. Only available if the object type is Todo

customerid

int

The ID of the customer which this checkin regards. Only available if the object type is Customer. Please note: If this checkin is on a task, this field is filled with 0 and not the customer ID to which the task is attached.

checkinlatitude

float

Geographical latitude for checkin

checkinlongitude

float

Geographical longitude for checkin

checkoutlatitude

float

Geographical latitude for checkout

checkoutlongitude

float

Geographical longitude for checkout

checkindate

date

Date when the checkin occured.

checkintime

time

Time when the checkin occured.

checkoutdate

date

Date when the checkout occured.

checkouttime

time

Time when the checkout occured.

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Date of last change (readonly)

changetime

time

Time of last change (readonly)

checkpoint

id

number

Check point ID in Microbizz

title

string

Check point title

competence

id

number

The ID of the competence in Microbizz

title

string

 

type

number

The type of competence, 1=on/off, 2=multi level

category

string

 

modcode

string

The module where that this competence 

levels

collection[string]

The names of the levels, only if type=2

colours

collection[string]

The colours of the levels, only if type=2

Notice that levels are number from 1 and up, so level 1 is the first level in the levels and colours fields.

crelationship

master

number

ID of the master customer of the relationship (readonly)

slave

number

ID of the slave customer of the relationship (readonly)

type

collection

Relation type and its binding settings (readonly)

startdate

date

Date for when the relation started (readonly)

enddate

date

Date for when the relation ended (readonly)

additionaldata

collection

Additional data (readonly)

cprelationship

id

number

Relationship ID in Microbizz (or zero if new relationship)

customerid

number

ID of the customer part of the relationship

customertext

string

A textual representation of the customer (readonly)

personid

number

ID of the person part of the relationship

persontext

string

A textual description of the person (readonly)

title

string

The title of the relationship

roleid