Complex types (part 3: S–W) 

id

number

One-time salary ID in Microbizz

userid

number

Reference for userid, if any

note

string

salarycode

number

Id of the salary code

date

date

count

number

The number of this one-time salary to add

todoid

number

Reference for todoid, if any

amount

number

The amount to be given as a one-time salary

id

number

Quotation ID in Microbizz

number

string

The quotation number

title

string

customerid

number

The Microbizz ID of the company

customertext

string

The name of the company

userid

number

The Microbizz ID of the seller

usertext

string

The name of the seller

requisition

string

unitid

number

The Microbizz ID of a unit

team

number

The Microbizz ID of the team

todoref

number

Reference for todo object.

todorefs

Array

Reference for all todos associated with the salescontract

contracttext

lstring

The description of the quotation

contracthtml

lstring

The description of the quotation as HTML. (readonly)

startdate

date

expecteddate

date

phaseid

number

The Microbizz ID of the phase

phasetext

string

The name of the phase

stateid

number

The Microbizz ID of the state, readonly

statetext

string

The name of the state

personid

number

The Microbizz ID of the responsible person

persontext

string

The name of the person

typeid

number

The Microbizz ID of the type of the quotation

typetext

string

The textual name of the type

createdate

date

(readonly)

createtime

time

(readonly)

changedate

date

(readonly)

changetime

time

(readonly)

id

number

Quotation ID in Microbizz

contractid

number

The Microbizz ID of the quotation

count

number

The number of items to add

units

string

The units, eg. 'kg' or 'liters' or whatever

itemnumber

string

The product number

baseprice

number

Read only

baseprice1

number

Writeable baseprice, only allows a single value, not monthly values

costprice

number

discount

number

The discount in %

itemname

string

The name of the product

note

string

issubscr

boolean

If the line is a subscription

createdate

date

(readonly)

createtime

time

(readonly)

changedate

date

(readonly)

changetime

time

(readonly)

id

number

Protocol ID in Microbizz

title

string

qfids

collection

List of questionform IDs to be completed in the specified order

serviceagreementid

number

taskreq

number

1 if it is required to select a task; 0 if it isn't required; 2 if the app shouldn't ask at all

type

string

Either "service" or "inspection"

id

number

Stock ID in Microbizz

title

number

Title of the stock

objecttype

string

Object type the stock is attached to. Either customer or tool

objectid

number

Id of the object the stock is attached to.

id

number

Stodo ID in Microbizz

assignedbyuserid

number

The ID of the user who created this reminder, may be 0

date

date

The date when the reminder should appear

time

time

The time when the reminder should appear

description

string

Description of the reminder

modcode

string

What type of object this reminder refers to, may be empty if there is no relevant object

objectid

number

The ID of an object that this reminder refers to

id

number

The Microbizz ID of the subscription

customerid

number

The Microbizz ID of a customer

teamid

number

The Microbizz ID of a team

productnumber

string

A product number used when invoicing

count

number

The number of items to invoice

unitid

number

The units of the items

title

string

The name of the subscription

description

string

The description of the subscription

period

number

The invoice period

nevermonths

collection[number]

Don't invoice in these months

requisition

string

price

number

The amount to invoice

discount

number

inheritdiscount

bool

If the discount should be taken from the customer

onseparateinvoice

bool

ahead

bool

startdate

date

When the subscription starts

expired

bool

The subscription is expired

nextinvoicedate

date

expiredate

date

When the subscription expires

todoids

collection[number]

List of relevant tasks

toolid

number

The ID of an equipment

id

number

Todo ID in Microbizz

number

string

Todo number in Microbizz

workareaid

number

Workarea ID. if set to an invalid workarea id. the id will be set to a random workarea to avoid todo failure.

workareatext

string

A textual representation of the workarea (readonly)

customerid

number

Customer ID.

customertext

string

A textual representation of the customer name. (readonly)

icons

collection[number]

A list of icon IDs to show on this todo.

iconlinks

collection

A list of links for the icons

checkpoints

collection[number]

A list of checkpoints to complete when checked in on this todo

title

string

Title

secondary_text

string

A secondary text describing this item; this is used as the search text

address

string

Address

address2

string

Second address-line

zip

string

Zip

city

string

City

country

string

Country

description

lstring

Longer description

htmldescription

lstring

Longer description, HTML formatted (from 2020 Q3); text specified in description will be converted to HTML, images are not included.

stateid

number

State of todo ID.

statetext

string

A textual representation of the todo state. (readonly)

isclosed

boolean

Indicates if todo is closed.

canclose

boolean

Indicates if the todo can be closed from an external system, such as an mobile phone

isaccepted

boolean

Indicates if todo is accepted as closed.

acceptdate

date

The date when the todo was accepted as closed.

priority

number

Priority.

estimate

number

Estimate in minutes.

timeusage

number

Time used in minutes.

userid

number

Responsible for todo. User ID.

closedby_userid

number

User ID of user who closed this task.

usertext

string

Responsible for todo in text. (readonly)

team

number

Team ID reference

subtodos

collection [number]

ID of all subtodos to this todo (readonly)

parenttodo

number

ID of a parent todo to this todo, if non-0 then this is a subtask to another task

ispersonal

boolean

Indicates that this todo belongs to the current user. (readonly)

isdeleted

boolean

Indicates if the todo should be shown or not. If this is true, then the todo should be considered as deleted. (readonly)

isprivate

boolean

Todo is private?

ispublic

boolean

Todo is public?

requisition

string

Requisition number

startdate

date

Start date.

deadline

date

Deadline.

closedate

date

Closed date

personid

number

The Microbizz ID of the person who is the contact person

persontext

string

The name of the person who is the contact person. This field is read-only.

temperature

number

Todo temperature. (readonly)

alertradius

number

Geofence radius (in meters) around this todo

longitude

float

GPS longitude

latitude

float

GPS latitude

invoicepolicy

string

See the table below for the possible values

invoiceperiod

string

One of the following values: "1w", "2w", "3w", "1m", "2m", "3m", "4m", "6m", "1y". "w" means week, "m" means month, "y" means year.

price

number

Todo price if the price is static.

price_writedown

number

Writedown of the todo price if the price is static (ie. how much have been payed?)

next_invoicedate

date

Date for next invoice (if task is repeating)

tasktype

number

1=AdHoc; 2=Repeat, exact; 3=Repeat, loose; 5=Project

createdby

number

id of user which created the task.

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Last change date (readonly)

changetime

time

Last change time (readonly)

qfonclose

number

For app: Question form ID of question form to present on close of this todo.

qfoncheckout

number

For app: Question form ID of question form to present on checkout from this todo

qfoncheckout_required

bool

If the question form in qfoncheckout is required or not

internalsubscribers

collection[number]

List of user IDs of the subscribers

externalsubscribers

collection[number]

List of person IDs of the subscribers

addresses

collection[ address ]

List of other addresses that are relevant

competences

set

List of competences and the minimum required level for each competence

seperate_invoice

boolean

Set to 1 if the task should be on a sep. inv. instead of on an inv. with other tasks for the same company

placename

string

The name of the delivery place

additionaluserids

collection[number]

List of IDs of additional users

contactname

string

Name of contact person, if Microbizz is setup to not use the personid field

contactphone

string

Phone of the contact person, if Microbizz is setup to not use the personid field

nextactiondate

date

Date of next planning, readonly

nextactiontime

time

Time of next planning, readonly

lastaction

date

Date of last planning, readonly

projectid

number

ID of a project (only if the Project module is enabled; this is not the parenttodo)

projectgroupid

number

ID of a projectactivity of type group

projecttext

string

The name of the project, see projectid

projectgrouptext

string

The name of the projectactivity, see projectgroupid

plannedto

collection[number]

List of users for whom this task is planned

parenttodo_ns_number

string

The task # of the parent task, if any

quotationid

number

If this is associated with a quotation+ quotation, then the ID of the quotation is listed in this field.

accord_isaccord

bool

If this task uses accord, readonly

accord_minutes

number

Accord minutes, readonly

accord_totalvalue

number

Total value of accord, readonly

accord_payed

number

Total value payed, readonly

accord_rate

number

Accord rate, readonly

accord_settledate

date

Date of accord payment, readonly

invoice_customerid

number

The Microbizz ID of the "payment company"

acceptby

number

The Microbizz ID of the user who approved the task, or 0 if not approved

slaid

number

The Microbizz ID of the type of SLA, or 0 if SLA is not used, readonly

slatext

string

The name of the SLA type, if SLA is used, readonly

sla_startdate

date

When the SLA clock was started, if SLA is used, readonly

sla_starttime

time

When the SLA clock was started, if SLA is used, readonly

sla_deadlinedate

date

The deadline of the SLA, if SLA is used, readonly

sla_deadlinetime

time

The deadline of the SLA, if SLA is used, readonly

usesubcontractor

bool

1 if the task uses a subcontractor

subcontractarea

number

The Microbizz ID for the company relation type

subcontractorid

number

The Microbizz ID of the subcontractor company

subcontractortext

string

The name of the subcontractor company, readonly

workpoolids

collection[number]

List of the IDs of the workpools that the task belongs to, readonly

inworkpool

bool

1 if the task is in one or more workpools, readonly

solutiontext

string

The solutiontext when invoicing the task.

By the hour

By the hour (summed)

To project

Fixed price

Fixed price (except products)

Per planned visit

Per planned visit (max 1 pr. day)

Per real visit

Per real visit (max 1 pr. day)

No charge

No charge (except products)

id

number

Team ID in Microbizz

title

string

Team title

remoteid

string

id

number

An ID identifying this line of product use

todoid

number

Todo ID, where this product was used.

count

float

Number of products used.

productnumber

string

Product number of the used product

linetext

string

Text of invoice line. Typically product name

unitprice

number

Price pr. unit in lowest local currency (Typically danish ører). This is before any discount is applied.

status

number

The Complex types#productusestate for this product use

orderid

number

Can be used for sorting

note

string

A note attached to this product use

isdeleted

boolean

Indicates if this product use is deleted

locked

boolean

Indicates if this product use is locked (ie cannot be modified or deleted)

invoiced

number

The invoiced status of the product use; either 0=not handled, 1=handled, 2= rejected

discount

float

A discount to be applied to the line. 0 = no discount, 100 = 100 % discount.

changedate

date

Last change date

changetime

time

Last change time

useddate

date

The date when the product was used

toolid

number

Tool ID

ediid

number

The ID of an EDI

budgetareaid

number

The Microbizz ID of the Complex types#budgetarea

stockid

number

The Microbizz ID of a Complex types#stock

units

string

The abbreviation of the product unit

unitid

number

The Microbizz ID of a product unit

costprice

number

The costprice.

listprice

number

The list price

userid

number

The ID of the user who created this product use; 0 if not created by a user; read only

productgroupid

number

The ID of the product group, see GetProductGroups

id

number

Todo state ID in Microbizz

title

string

Todo state title

isclosestate

boolean

Is this state a closed state?

color

string

The colour used for the state

access

bool

Is the user allowed to select this state?

workareas

set

List of workarea IDs that allow this state

orderid

number

The ordering ID, used for sorting the states for display

id

number

Todo state history ID in Microbizz

todoid

number

Todo id of task with this state.

stateid

number

Todo state ID in Microbizz

date

date

The date when the state changed

time

time

The time when the state changed

title

string

The name of the state

id

number

Template id in Microbizz

title

string

Template title

requirecustomer

bool

This is 1 if the template requires that a customer is specified

subtemplates

collection

List of the subtemplates, each is a set with {id,title}

id

number

Tool ID in Microbizz

name

string

Tool name

secondary_text

string

A secondary text describing this item; this is used as the search text

userid

number

User ID of responsible user. Please note that the responsible user, is not always the same as the person carrying the tool.

usertext

string

A textual representation of the responsible user. (readonly)

carrier_userid

number

User ID of user carrying the tool. If this is 0 or not present, the tool is currently not carried. (readonly)

carrier_usertext

string

A textual representation of the user carrying the tool. (readonly)

is_carrier

boolean

True of the current user is the carrier. (readonly)

containedin

number

Tool ID of the tool in which this tool is contained.(readonly)

containedintext

string

A textual representation of the tool in which this is contained. (readonly)

is_installed

boolean

Indicates if this tool is installed somewhere. (readonly)

installed_placetext

string

A textual representation of where this tool is installed. (readonly)

number

string

Tool number

code

string

Tool code

class

string

Tool class (readonly)

groupid

number

ID of tool group

group

string

Tool group (readonly)

make

string

Tool make

model

string

Tool model

serialnumber

string

Tool serial number

nextservice

date

Date of next service

lastservice

date

Date of last service

isdeleted

boolean

Indicate if the tool is deleted

longitude

float

GPS longitude of the last known position of this tool.

latitude

float

GPS latitude of the last known position of this tool.

latlonsource

string

The source when GPS position was retrieved. Can be one of the following: “event”, “geofence”, “gps”

latlondatetime

datetime

Date and time for retrieving GPS latitude and longitude.

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Last change date (readonly)

changetime

time

Last change time (readonly)

qfonsetdown

number

For app: Question form ID on question form to present on set down of this tool.

attachedcustomerid

number

Customer ID

customerid

number

The Microbizz ID of the “place of home”

todoid

number

Todo ID, if multiple then see todoids

todoids

array

A collection of Todo IDs, the tasks that are currently associated with the equipment

barcode

string

Tool barcode

personid

number

ID of a Person

persontext

string

The name of the contact person

icons

collection[number]

The IDs of the custom fields of types "icon" or "icon url" that are set

iconlinks

set

The URLs for custom fields of type "icon url" that are set

partslist

collection[ Complex types#partslist ]

List of parts in the parts list for the equipment type

serviceprotocols

collection[number]

The IDs of the service protocols that are available

stateid

number

The ID of the current state

statetext

string

The name of the current state

servicestatus

number

1=serviced, 2=not serviced, 3=service soon, 4=past service

picture

string

Image of tool as base64 encoded image data. Please note that only some commands return this field.

active

boolean

If the tool is active or not.

remoteid

string

The remote ID of the equipment

id

number

The Microbizz ID of the state

title

string

Name of the state

color

string

The colour to use when displaying the state

access

boolean

If the current user is allowed to select this state

id

number

The ID of the type

title

string

The title of the type

groupcode

string

The title of the groupcode

allowregs

bool

If the tool type allow registrations

allowedforms

set

List of IDs of the question forms that are allowed for this tool type

periodtype

number

The service period type, see below

period

number

The service period, either days, hours or kilometers, depends on periodtype

class

number

id

number

The Microbizz ID of the thread

objecttype

string

objectid

number

title

string

The title of the thread

ispublic

bool

If the thread should be shown on the extranet and elsewhere

isdeleted

bool

1 if the thread has been deleted

isunread

bool

1 if the current user hasn't read all the messages in the thread

tags

collection[string]

List of tags, each tag is a short text

lastmessagedate

date

Date of last message

lastmessagetime

time

Time of last message

createdate

date

(readonly)

createtime

time

(readonly)

messages

collection[ Complex types#tmessage ]

externalsubscribers

collection[number]

List of person IDs of subscribers

internalsubscribers

collection[number]

List of user IDs of subscribers

id

number

Unit ID in Microbizz

title

string

Title of the unit

customerid

number

ID of a customer in Microbizz

customertext

string

The name of the customer

processid

number

ID of the process in Microbizz

processtext

string

Name of the process

userid

number

ID of the user in Microbizz

usertext

string

The name of the user

phaseid

number

The ID of the phase in Microbizz

phasetext

string

Name of the phase

isclosed

bool

startdate

date

Date created

nextdeadline

date

Date created

finaldeadline

date

Date created

closedate

date

Date created

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Last change date (readonly)

changetime

time

Last change time (readonly)

id

number

User ID in Microbizz

fullname

string

Full name

initials

string

Initials

usercode

string

A number identifying the user, such as an employee-number

email

email

Email / login.

password

string

Password. Please note that Microbizz only stores hashes of passwords, so when receiving a user type, the password field will always be blank.

mobile

string

Mobile phone number

mobilepin

string

Mobile pin code for the mobile app.

allowsms

boolean

Is the user allowed to SMS to the system

isactive

boolean

Is the user active.

isadministrator

boolean

Is the user an administrator.

licensetype

string

Either Full or Mobile or Passive

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Last change date (readonly)

changetime

time

Last change time (readonly)

usertypeid

number

The ID of the user type

usertypetext

string

The name of the user type, eg. “Administrative personelle”

usertypecolor

string

The color used to indicate the user type

stdteamid

number

The ID of the home team for this user

address

string

The address of the user

address2

string

ged

zip

string

city

string

country

string

The address of the user

birthdate

date

Birthdate of user

hiredate

date

The date the user was hired

senioritydate

date

The senioritydate of the user

deactivationdate

date

If the user is deactivated this was the date of the deactivation.

competences

set

List of the competences that apply to this user, and the level for each, e.g. {2:5,1:4} means that the user has level 5 of the competence with ID=2, and level 4 of the competence with id=1, see the API call GetCompetences

requestconsent

boolean

If the user should be asked to consent to GDPR whenever the GDPR setup changes

registration_policy

number

If the user is required to register time: 1=optional, 2=required, 3=automatic

gps_policy

number

When Microbizz remembers the location of the user: 0=never, 1=work time, 2=always

usesalary

bool

If the salary system takes this user into account (requires that the salary system is enabled)

salarymodel

number

The ID of the salary model

salaryusercode

string

The user code used in the salary system

stockid

int

id of the stock the user is connected to. Only avaliable with version 2

memberteamids

collection

IDs of the teams that the user is a member of, readonly

leaderteamids

collection

IDs of the teams where the user is TL, readonly

roles

collection

IDs of the roles that the user has, see GetUserRoles

newui

bool

If the user uses the new UI

id

number

Widget ID in Microbizz

type

string

The type of widget, currently only "iframe" is supported

link

string

For "iframe" widgets this is the URL to display within an iframe

id

number

Workarea ID in Microbizz

title

string

Workarea title

category

string

Workarea category

access

bool

If the user may select this workarea when registering time, editing tasks etc.

id

number

Workplan entry ID in Microbizz. (readonly)

date

date

userid

number

The ID of the user this registration is about.

regtypeid

number

The ID of this type of workplan entry

color

string

title

string

Title of this type of workplan entry, eg. 'Holiday' or 'Sick'

atwork

boolean

1 if the user is at work on this day

holiday

boolean

1 if this is a public holiday, eg. christmas

workdayduration

number

Duration of work day, in minutes. May be 0.

editedby_userid

number

The MB ID of the user who last edited the workplan entry for this date+user

busyminutes

number

Minutes of planned work/appointments on this date

id

number

Workpool ID in Microbizz

title

string

The title of the workpool

groupid

number

The group ID of the responsible group/team

userids

collection[number]

A list of user IDs

entries

collection[ Complex types#workpoolentry ]

A collection of workpool entries

id

number

Workpool entry ID in Microbizz

todoid

number

Todo ID in Microbizz

title

title

Title of the Todo

deadline

date

estimate

number

Number of minutes

changedate

date

(readonly)

changetime

time

(readonly)

createdate

date

(readonly)

createtime

time

(readonly)

id

number

Ticket ID in Microbizz

number

string

Ticket number in Microbizz

accountid

number

Account the ticket is assigned to

customerid

number

The id of the customer the ticket belongs to

name

string

The name of the ticket

state

number

The number of the state

statename

string

The name of the state

stateid

number

The id of the state

statetext

string

The description of the state

typeid

number

The id of the type

typetext

string

The name of the type.

tags

array

The array of text tags

user

number

The user who created the ticket

original_ticketid

number

The ticket id the ticket may have been created from

ticketnumber

number

The number of the ticket.

personid

number

The person id of the person assigned to the ticket

phonenumber

string

The phone number of the person assigned to the ticket

closedate

date

The closing date.

closetime

time

The closing time

closedby_userid

number

The id of the user who closed the ticket.

createdby_userid

number

The id of the user who created the ticket.

closed

boolean

If the ticket is closed

pending

boolean

If the ticket is pending

email

string

The email of the contactperson

lastestemailfrom

string

Last email to this ticket

lastestemailbody

string

Last email text.

lastestemailsubject

string

Last email subject

latestemaildate

date

Last email date of recieving.

lastnote

string

Last note text

lastresponsiblechange

date

Date of responsible change

lastmaildate

date

Date of last recieved mail

laststatechange

date

Date of last state change

lastnotetime

time

Time of last note

lastresponsiblechangetime

time

Time of last responsible change

lastmailtime

time

Time of last mail recieved

laststatechangetime

time

Time of last state change.

lastcommtime

time

Time of last communication

users

array

Array of relevant users for the ticket.

timesincelast

string

Time for last communication

todos

array

Array of tasks assigned to this ticket.

registrationtime

number

Time in minutes of how much is registered.

invoicedtime

time

The of minutes invoiced so far.

invoicepolicy

string

The policy used for invoicing. based on the customer.

source

string

The text the number displays.

sourceid

number

A number indicating where the ticket was from.

description

string

The full description of the ticket.

createdate

date

Date of creation (readonly)

createtime

time

Time of creation (readonly)

changedate

date

Date of latest change. (readonly)

changetime

time

Time of latest change. (readonly)