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.

(readonly) This field is only provided when receiving objects from the API. It is ignored when transmitting to the API.


address

typestringDescription of the type of address, eg. 'Home' or 'Nearest depot' or whatever
fullstringFormatted address
namestring
name2string
addressstring
address2string
zipstring
citystring
countrystring
latitudefloat
longitudefloat

anchorbudget

idnumberThe Microbizz ID of the anchor budget
useridnumberThe Microbizz ID of the user who created/edited this
todoidnumberThe ID of the task this budget post refers to
datedateThe date this was added
anchorsetThe budget values, indexed by the budget post IDs

baselayer


layeridstringThe ID in Microbizz
titlestringThe name of the base layer
modulescollection[string]List of modcode where this baselayer should be available
changedatedate
changetimetime
copyrightstringCopyright message to display on the map
deletedbooleanSet to 1 if the baselayer has been deleted and should no longer be available
formatstringMIME type of the images, eg 'image/png'
layersstringA string to pass to the WMS server
ordernumberSort order in the list
projectionstringThe projection used, eg. 'epsg:25832' or 'webmercator'
typestringSet to 'wms' if this is a WMS map; otherwise it is a tile map
urlstringThe URL of the WMS server or the tile server


budgetarea


idnumberThe ID in Microbizz
titlestringThe name of the budget area


budgetpost

postidnumberThe Microbizz ID of the post
todoidnumberThe ID of the task this budget post refers to
budgetpostidnumberThe Microbizz ID of a budget area
datedateThe date this was added
amountnumberThe budget value

call


idnumberCall ID in Microbizz
customeridnumberID of customer attached to this call
customertextstringTextual representation of the customer (readonly)
personidnumberID of person attached to this call.
persontextstringTextual representation of the person. (readonly)
calltextstringTextual 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)
mainnumberstringIf a main number is available to dial, it is provided in this field. (readonly)
directnumberstringIf a direct number is available to dial, it is provided in this field. (readonly)
mobilenumberstringIf a mobile number is available to dial, it is provided in this field. (readonly)
calldatedateThe date when the call is expected to take place.
calltimetimeThe time when the call is expected to take place.
notestringA note regarding the call
qfonendnumberFor app: Question form ID on question form to present on ending this call. (readonly)

checkin


idnumberCheckin ID in Microbizz
ischeckedinbooleanTrue if the status of this checkin is checked in.
readablestringTextual representation of the place where the checkin occured.
objecttypestringThe object type on which we logged in. Customer or Todo
toolidintIf this checkin regarded a tool, then this is the toolid.
useridintReference to user who performed the checkin.
todoidintThe ID of the task which this checkin regards. Only available if the object type is Todo
customeridintThe 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.
checkinlatitudefloatGeographical latitude for checkin
checkinlongitudefloatGeographical longitude for checkin
checkoutlatitudefloatGeographical latitude for checkout
checkoutlongitudefloatGeographical longitude for checkout
checkindatedateDate when the checkin occured.
checkintimetimeTime when the checkin occured.
checkoutdatedateDate when the checkout occured.
checkouttimetimeTime when the checkout occured.
createdatedateDate created
createtimetimeTime created
changedatedateDate of last change
changetimetimeTime of last change


checkpoint


idnumberCheck point ID in Microbizz
titlestringCheck point title


competence


idnumberThe ID of the competence in Microbizz
titlestring
typenumberThe type of competence, 1=on/off, 2=multi level
categorystring
modcodestringThe module where that this competence 
levelscollection[string]The names of the levels, only if type=2
colourscollection[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.


cprelationship


idnumberRelationship ID in Microbizz (or zero if new relationship)
customeridnumberID of the customer part of the relationship
customertextstringA textual representation of the customer (readonly)
personidnumberID of the person part of the relationship
persontextstringA textual description of the person (readonly)
titlestringThe title of the relationship
roleididRole id for a role the object is based on.. this cannot be changed once set. instead the cprelationship will be closed and another created
sincedateThe date the relationship was formed
untildateThe date the relationship ended or empty if current
createdatedateDate created
createtimetimeTime created
changedatedateDate of last change
changetimetimeTime of last change

customer

idnumberCustomer ID in Microbizz
customernumberstringCustomer number
creditornumberstringCreditor number
namestringName
descriptionlstringAn optional string describing the customer
secondary_textstringA secondary text describing this item
iconscollection[number]A list of icon IDs to show on this customer
ourreferencenumberOur reference; must be a valid User ID
ourreferencetextstringTextual representation of our reference (readonly)
theirreferencenumber

Their reference; must be a valid Person ID 

theirreferencetextstringTextual representation of their reference (readonly)
vatstringVAT number (danish CVR)
vatpercentagenumberThe VAT amount in %
publicidstringPublic identification number (danish EAN)
addressstringAddress
address2stringSecond address line
zipstringZip
citystringCity
countrystringCountry
invoiceaddressstringAddress
invoiceaddress2stringSecond address line
invoicezipstringZip
invoicecitystringCity
invoicecountrystringCountry
phonestringPhone no
faxstringFax no
wwwstringWeb address, not URL
emailstringEmail adresse
tradestringCompany trade
teamnumberTeam ID
typeidnumberThe customer type ID
typetextstringTextual representation of the customer type (readonly)
alertradiusnumberGeofence radius (in meters) around this customer
isprospectbooleanIs company a prospect?
issubcontractorbooleanIs company a subcontractor?
isblockedbooleanIs company blocked?
isdeletedbooleanIs company deleted?
invoiceupboolean1 if the parent company is invoiced, 0 if not
longitudefloatGeographical longitude
latitudefloatGeographical latitude
createdatedateDate created
createtimetimeTime created
changedatedateDate of last change
changetimetimeTime of last change
parentcustnumberThe ID of the parent customer
selleridnumberThe ID of the sales person
maingroupidnumberThe ID of the maingroup, see the API call GetMaingroups
startdatedateThe start date of a Customer
requestconsentboolIf the customer should be asked to consent to GDPR whenever the GDPR setup changes
mailimportboolIf 1 then mail for this customer will be imported by Microbizz

This object may include custom fields.

customertype

idnumberCustomer type ID
titlestringCustomer type title
colorstringCustomer type colour

customfield

idnumberCustom field ID
titlestringThe title of the custom field
visibilitycollection[number]A list of type IDs for which this field should be visible, see below
typenumberThe type of custom field, see custom fields
showinappboolean1 if the custom field should be shown in the app, 0 if not
subtypenumberHint to what the field is used for
iconnumberID of an icon (only for type 10=icon), see GetIcons
colorscollection[string]Only for type 3=dropdown, colours to use when displaying the list of selectable values
valuescollection[string]Only for type 3=dropdown, 7=multicheck and 17=combobox, list of values that may be selected

See custom fields for more details.

customregistration

idnumberCustomregistration ID
titlestringThe name of the custom.reg.
fieldtypenumber

The type of custom.reg.,

1=checkbox

2=float

3=menu

only_onceboolIf 1 then only one of this type is allowed per user per day
no_exceedboolIf 1 then the value is not allowed to exceed the number of minutes on the registration (only for fieldtype=2)
optionscollection[string]The available options (only for fieldtype=3)

directorderline


countnumberNumber of items
linetextstringProduct description
itemnumberstringProduct number
pricenumberPrice (multiplied by 100)
notestringA note for the line


depot


idnumberDepot ID
titlestringDepot title
customeridnumberThe ID of the company, if the depot belongs to a company
toolidnumberThe ID of the equipment, if the depot belongs to an equipment
itemscollectionList of depot items, each contains id,title,productnumber,units,maxitems


edi

idnumberThe Microbizz ID of the EDI
todoidnumber

The ID of a todo

maingroupidnumberThe ID of a maingroup
budgetareaidnumberThe ID of a budgetarea
edinumberstringThe EDI invoice number
customeridnumberThe ID of a customer
customertextstringThe name of the customer
buyersreferenceidstring
buyerpartyidstring
deliverypartyidstring
ourreferenceidstring
ourreferencenamestring
theirreferenceidstring
theirreferencenamestring
sellersorderidstring
buyersorderidstring
sellernamestring
selleraddressstring
sellerzipstring
sellercitystring
sellereanstring
sellercvrstring
sellercountrystring
delivernamestring
deliveraddressstring
deliverzipstring
delivercitystring
delivercountrystring
deliverdatedate
paymentamountnumber
taxamountnumber
paymenttermsset
notestring
statestring
phasenumber
phasetextstring
useridnumber
usertextstring
currencystring
iserrorboolean
errortextstring
exportedboolean
exportdatedate

ediline

idnumberThe ID of the EDI line
ediidnumberThe ID of the EDI that this line belongs to
titlestring
descriptionstring
deliverydatedate
qtynumberNumber of items
pricenumber
unitsstringThe unit of the items, eg "boxes" or "liters"
notestring
basepricenumber
productnumberstring
todoidnumber
statenumber
todoitemidnumberThe ID of a todoitem that was created from this line
budgetareaid numberThe ID of a budget area

eventtype

idnumberEvent type ID
titlestringEvent type title
durationnumberDefault duration in minutes for this event type
colorstringColour to use with this type of event


event

idnumberEvent ID in Microbizz, or 0 when creating a new event
useridnumberThe ID of a user; must be 0 when creating a new event
customeridnumberID of the customer this event concerns
datedateEvent date
timetimeEvent time
minutesnumberEvent duration in minutes
typenumberThe event type, see GetEventTypes
titlestringTitle of the event
customertextstringTitle of the customer
secondary_textstringText to display in the UI
personidnumberThe ID of a person, this may be 0 even if persontext is set
persontextstringName of a person
placestringTextual description of the location
notelstringA note for the event
useridscollection[number]List of IDs of all the users who participate
instanceidstringThe Microbizz ID of the instance, this is read-only
followupboolean1 if the event has followup
followupafternumberNumber of days before followup
followupstatusnumberOne of 0:Pending, 1:Cancelled, 2:OK
followupby_useridnumberThe Microbizz ID of the user who should followup
followupby_usertextstringThe name of the user who should followup
changedatedateThe date of last change
changetimetimeThe time of last change

When creating/updating an event the field persontext is ignored, only personid is used to determine the person.

See Event commands for a description of the difference between an event and an instance of an event. 

depotorderline

idnumberDepot orderline ID in Microbizz
itemnumberstringProduct number
countnumberNumber of items
itempricenumberThe price of each item
datedateThe date the line was added
linetextstringNote or description
customeridnumberThe company ID in Microbizz
customertextstringThe name of the company
useridnumberThe user ID in Microbizz
usertextstringThe user name
exportdatedateThe date when the line was exported


document

idnumberFile ID in Microbizz
titlestringDocument title, eg. “My Picture”
filenamestringOriginal filename of document, eg. “mypicture.jpg”
pathstringThe complete path of the filename as it is stored in the Microbizz system local folder structure
typestringDocument type (ex. “pdf”, “jpg”, “xml”) or “unknown”
sizenumberDocument size in KB
createdatedateDocument create date
createtimetimeDocument create time
thumbbinaryThumbnail of the file, base 64 encoded
folder_refnumberThe ID of the folder which contains this document
ispublicboolean1 if the file is visible on the extranet
modcodestring
objectidnumber


feature

A feature is something which is displayed on top of a map.

dataidnumberFeature ID in Microbizz
layerrefnumberOnly used when transferring a feature to Microbizz
modcodestringOnly used when transferring a feature to Microbizz
sysrefnumberOnly used when transferring a feature to Microbizz
datamixedDepends on the datatype
datatypenumberFeature type, see Map features for details
namestring
colour1stringDepends on the datatype
colour2stringDepends on the datatype
sizenumberDepends on the datatype


If dataid is 0 then a new feature is created.

If layerref is -1 then it refers to a default layer for the object specified by modcode + sysref. If layerref is > 0 then it is the ID of an existing layer, and modcode + sysref is ignored by Microbizz.

See Map features for details.

JSON encoded example of a feature:

{"dataid":0,"layerref":83,"datatype":22,"data":{"points":[{"x":27,"y":55},{"x":27.5,"y":55},{"x":27,"y":55.5}]},"colour1":"#ff00ff","size":2}


folder

idnumberFolder ID in Microbizz
titlestringFolder title
parentidnumberThe ID of the parent folder, or 0 if this is the root folder for the object


icon

idnumberIcon ID in Microbizz
titlestringIcon title
databinaryThe binary data of a PNG representing the icon
md5sumstringMD5 sum of the data


imagetag

idnumberImage tag ID in Microbizz
tagstringThe image tag


invoice

idnumberID of the invoice
numberstringThe Invoice number
requisitionstring
customeridnumberThe ID of a Customer in Microbizz
customertextstringThe name of the Customer
useridnumberThe ID of a user in Microbizz
usertextstringThe name of the user
selleridnumberThe ID of the user who is the seller
sellertextstringThe name of the user who is the seller
teamnumberThe ID of the team to whom the invoice belongs
fromnamestringAddress 
fromaddressstring
fromaddress2string
fromzipstring
fromcitystring
fromcountrystring
frompersonstring
fromemailstring
tonamestringAddress
toaddressstring
toaddress2string
tozipstring
tocitystring
tocountrystring
topersonstring
toemailstring
toeanstring
deliverynamestringAddress
deliveryaddressstring
deliveryaddress2string
deliveryzipstring
deliverycitystring
deliverycountrystring
additionaltext1stringText that describes the invoice
additionaltext2stringText that describes the invoice
totalsumnumberThe total sum of the invoice lines
payment_currencystring
remaindernumber
bookeddatedate
paiddatedate
duedatedate
invoicedatedate
paymentterms_outnumber
layout_outnumber
paymentterms_innumber
layout_innumber
ispostedbool
ispayedbool
iscreditbool

iserror

boolIf this invoice failed
errortextstringThe error text from when the invoice failed
bouncetextstring
theirrefstring
remoteidstring
nonstickbool
createdatedate
createtimetime
changedatedate
changetimetime


invoiceline

idnumberID of the invoice line
customeridnumberID of the customer to which this line should be invoiced
related_customeridnumberID of the customer which this line regards. This can differ from the customerid if you redirect your invoicing from one customer to another.
invoiceidnumberThe ID of an invoice
todoidnumberIf the invoice line can be attached to a todo then this holds the ID of the todo
datedateDate of the invoice line
linetextstringText of the invoice line
productstatusnumberThe product use status for the product behind this invoice line
stocknumberA reference to a stock from where the product is removed.
discountnumberA discount to be applied to the line. 0 = no discount, 100 = 100 % discount.
itemnumberstringItem number of the invoice line (product number)
countnumberItem count of the invoice line
pricenumberPrice per unit in lowest local currency (typically Danish ører). This price is before any discount.
unitsstringThe product unit


maevent

idnumberId of MA event.
eventtitlestringTitle of event


maillist

idnumberList id in Microbizz
titlestringList title


mailreceiver

customeridnumberTo which company is this receiver related.
personidstringIf the receiver is a person, a person ID is also provided. This can be provided in conjunction with a customer id if the person are associated with the given company
namestringThe name of the receiver
emailstringThe email of the receiver


mainpage

objecttypestringThe type of object this mainpage is used with
boxescollection[ mainpagebox ]List of boxes to display


mainpagebox

boxstringThis specifies what type of box this is, some types are built in, some refer to a column group or a widget
titlestringThe title of the box
iscolumngroupboolean1 if the box contains a column group
columngroupidnumberThe ID of a column group (if iscolumngroup is set)
iswidgetboolean1 if the box is a widget, is is not valid for iscolumngroup and iswidget to both be set
widgetidnumberThe ID of a widget (if iswidget is set)


md5list

idnumberRefers to an ID in another list
md5sumstringThe MD5 sum of data in another list


message

“instant” messages.

idnumberThe MB ID of the message
useridnumberThe MB ID of the User who sent the message
usertextstringThe name of the user
messagelstringThe message text
datedateThe date of the message
timetimeThe time of the message
confirmationnumber0=no confirmation, 1=pending confirmation, 2=confirmed
readboolean1 if the message has been read
modcodestringAn optional string which describes which type of object this message relates to
objidnumberThe ID of the object that this message relates to



tmessage

Messages that are part of a thread, ie. belong to an object of some kind.

idnumberThe MB ID of the message
threadidnumberThe MB ID of a thread
useridnumberThe MB ID of the user who wrote the message, should be 0 if it was a person
personidnumberThe MB ID of the person who wrote the message, should be 0 if it was a user
authornamestringThe name of the user/person who wrote the message
changedatedate
changetimetime
isunreadbooleanIf the message is unread by the current user
messagelstringThe message text, may include HTML tags



mbmessage

Messages that are part of a conversation between two or more users.

idnumberThe MB ID of the message
messagelstringThe message text, this is actually HTML
receiverscollection[number]List of IDs of users to receive the message
conversationidnumberThe MB ID of a conversation
useridnumberThe ID of the user who wrote the message
usertextstringThe name of the user who wrote the message
datedate
timetime
isunreadbooleanIf the message is unread


Creating a new mbmessage: if conversationid is set then receivers is ignored; if conversationid is not set then receivers is required.


note


idnumberId of the note
objecttypestringTo which object is this note attached. “customer” or “task”.
objectidnumberEither customer ID or todo ID
useridnumberId of user from where this note originated
usertextstringName of the user from where this note originated. (readonly)
receiveridnumberId of user where this note is going to
receivertextstringName of user where this note is going to. (readonly)
datedateDate of the note
timetimeTime of the note
textlstringThe text of the note


notification


idnumberID of the notification
assignedbynumberThe ID of the user who caused this notification, or 0 if it was a person
assignedby_personidnumberThe ID of the person who caused this notification, or 0 if it was a user
textstringThe notification text, may include links and HTML tags
datedateThe date of the notification
timetime
ispublicbool1 if the notification should be marked as “public”
isreadbool1 if the notification has been read/dismissed
objecttypestringAn object type indicating what object the notification relates to
objectidnumber
message_threadidnumberThe ID of the related thread, if objecttype is message

If objecttype is message then the notification refers to a note/tmessage, and the field message_threadid contains the ID of the thread.


partslist


partidnumberThe ID of the parts list; IDs are only unique within a tool type.
productnumberstringA product number.
productnamestringThe name of the product.
countnumberNumber of items expected to be used.
unitsnumberThe ID of a unit.


partuse


toolrefnumberThe Microbizz ID of a tool
countnumber
partidnumberThe partid from a partslist


person


idnumberPerson ID in Microbizz
firstnamestringPerson first name
lastnamestringPerson last name
addressstringPerson address
address2stringPerson address2
zipstringZip
citystringCity
countrystringCountry
phonestringPhone no.
mobilestringMobile.
faxstringFax no.
wwwstringWeb address
emailemailEmail.
secondary_textstringA secondary text describing this item.
createdatedateDate created
createtimetimeTime created
changedatedateLast change date
changetimetimeLast change time
typeidnumberThe ID of the person type in Microbizz, see GetPersonTypes
typetextstringTextual representation of the person type
isdeletedboolIf the person is deleted/deactivated
requestconsentboolIf the person should be asked to consent to GDPR whenever the GDPR setup changes
teamnumberreference to the team the person is a part of.

This object may include custom fields.

persontype


idnumberPerson type ID in Microbizz
titlestringName of the person type
colorstringThe colour to use for this person type
codestringA one-character code denoting the type


plandestination


idstringId of destination.
destinationstringTerm of destination

id is either a U followed by a user ID, or a T followed by a team ID, f.ex. U23 or T4. destination is the name of the user / team.


procedure


idnumberThe Microbizz ID
modcodestringThe module to which this belongs
sysrefnumberThe ID of an object in the module
isdeletedboolean1 if the procedure has been deleted and should not be shown
titlelstringThe title of this procedure
textstringThe text for the procedure
visible4collection[number]

Currently modcode is always customers and so sysref refers to the ID of a company.

visible4 is a list of company types for which the procedure should be shown.


prodplanentry


idnumberId of this production entry in Microbizz
useridnumberWho is going to work on the todo? User ID
todoidnumberWhich todo? Todo ID
todotextstringA textual representation of the todo. (readonly)
secondary_textstringA secondary text describing this item.
datedateDate of work.
timetimeTime of work.
placestringPlace of work. DEPRECATED.
durationinminutesnumberDuration of work in minutes.
lockedboolIf the production is locked
visitedboolIf the production has been visited by the user (readonly)
activitycolorstringThe colour to use when displaying this entry
createdatedateThe date when this was created
createtimetimeThe time when this was created
displaytimestringFor normal planning this holds starttime and endtime (eg. “09:00 - 12:00”); for full day planning it holds the string “Full day” or similar
typeboolean1 if this is a full day planning, 0 if it is a normal planning


product


idnumberInternal Microbizz product ID
productnumberstringThe product number
barcodestringBarcode number
groupstringName of product group. Microbizz automatical creates and deletes these groups on demand.
subgroupstringName of product subgroup. Microbizz automatical creates and deletes these subgroups on demand.
titlestringProduct title
pricenumberProduct base price in lowest local currency. (Typical danish ører)
costpricenumberProduct cost price in lowest local currency. (Typical danish ører)
isdeletedbooleanIndicates if this product is deleted
sparepartboolean1 if this is a sparepart
supplieridnumber
favoriteboolean1 if this is one of the user's favourite products; use AddFavoriteProduct to update this
secondary_textstring
unitsstringThe abbr. of the product unit (readonly)
unitidnumberThe ID of the product unit
productgroupidnumberThe ID of the product group, see GetProductGroups


productunit


idnumberInternal Microbizz product unit ID
titlestringThe name of the unit, eg. 'Liters' or 'meters'
abbrstringThe abbreviation or the title, eg. 'l' or 'm', max 5 chars


productusestate


idnumberInternal Microbizz product use status ID
titlestringThe name of the status
colorstringFormat is '#RRGGBB'
defaultboolIf this should be the default product use state
showinappboolIf this should be displayed for product uses
useinappboolIf this should be selectable


project

idnumberInternal Microbizz product use status ID
numbernumberThe project #
workareaidnumberInternal Microbizz workarea ID
workareatextstringName of the workarea
customeridnumberInternal Microbizz customer ID
customertextstringName of the company
titlestringThe name of the project
descriptionstring
addressstring
address2string
zipstring
countrystring
stateidnumberInternal Microbizz project state ID
statetextstring
isclosedbool
prioritynumber
estimatenumberEstimate in minutes
useridnumberInternal Microbizz user ID
usertextstringThe name of the user
teamnumberInternal Microbizz team ID
isdeletedbool
ispublicbool
requisitionstring
startdatedate
deadlinedate
closedatedate
projecttypenumberInternal Microbizz project type ID
personidnumberInternal Microbizz person ID
persontextstringThe name of the contact person
longitudefloat
latitudefloat
invoicepolicynumberInternal Microbizz invoicepolicy number
pricenumber
createdatedate
createtimetime
changedatedate
changetimetime

projectactivity

idnumberInternal Microbizz projectactivity ID
titlestringThe name of the activity
projectidstringInternal Microbizz project ID
projecttextstringThe name of the project
objecttypestringThe type of object that is attached to this activity, either todo or event or empty
objectidnumberThe ID of the object
parentidnumberThe ID of the parent activity or 0
parenttextstringThe name of the parent
startdatedate
enddatedate
durationnumberDuration in days
estimatenumberEstimate in minutes
progressnumberProgress from 0 - 100
createdatedate
createtimetime
changedatedate
changetimetime

projecttemplate

idnumberThe Microbizz ID of the project template
titlestringThe title of the project template
typenumberThe ID of the project type, see GetProjectTypes

projecttype

idnumberThe Microbizz ID of the project type
titlestringThe title of the project type
colorstringColor for the project type, format is "#RRGGBB"


registrationentry

idnumberID of this specific registration in Microbizz.
isdeletedbooleanIndicate if this registration is a deleted registration.
useridnumberThe user id of the user making the registration.
datedateDate of registration
lockedbooleanIt indicates if a registration is locked. A locked registration cannot be edited or deleted.
approvedboolean

It indicates if a registration day (work sheet) is approved by a team leader in the Microbizz system.

When writing this it approves only the registration and sets the active user as the one who approved.

approvedbyintthe userid of the user which approved the registration.
gpslockboolean1 if the GPS cordination was within 500 m of the expected location
registrationtextstringThis is a textual representation of the registration, used to display the registration. (readonly)
todoid*numberWhich todo? Todo ID
customerid*numberWhich customer? Customer ID.
internalid*numberWhich internal registration? Internal registration ID, see GetInternalRegistrations
workareaidnumberWorkarea ID
starttimetimeTime the registration started.
minutesnumberNumber of minutes worked.
notestringAn optional note to attach to the registration.
star1booleanStar 1
star2booleanStar 2
star3booleanStar 3
star4booleanStar 4
longitudefloatGPS longitude from where the user performed the registration
latitudefloatGPS latitude from where the user performed the registration
toolidnumberTool ID
costpricenumberThe costprice of the registration
srcnumberSubsystem that generated this entry: 1=manual, 2=automatic, 3=checkout, 4=ticket
srcidnumberDepends on src, can be ID of a checkin or ID of a ticket
invoicednumberThe invoiced status of the registration; either 0=not handled, 1=handled, 2= rejected
customregistrationssetIf the "custom registrations" special functionality is enabled, any custom registration is included in this field. In each item in the set, the key of the item is the custom registration id and the value is the value of the selection.

(*) means that one of these must be set.

registration_internal

idnumberID of this internal registration
texttextThe title of this external registration

repeat

wgrepeat

The repeat object is for todos of the type "repeat, exact", the wgrepeat object is for todos of the type "repeat, loose".

idnumberThe Microbizz ID of this repeat
todoidnumberThe Microbizz ID of the todo that this repeat belongs to
useridnumber

The Microbizz ID of a user (repeat only)

usertexttextThe name of the user (repeat only)
repetitiontextSee How do I import repetitions on tasks? for details
isdeletedbool1 if this has been deleted
createdatedate
createtimetime
changedatedate
changetimetime


team

idnumberTeam ID in Microbizz
titlestringTeam title
remoteidstring

salescontract

AKA quotation.

idnumberQuotation ID in Microbizz
numberstringThe quotation number
titlestring
customeridnumberThe Microbizz ID of the company
customertextstringThe name of the company
useridnumberThe Microbizz ID of the seller
usertextstringThe name of the seller
requisitionstring
unitidnumberThe Microbizz ID of a unit
teamnumberThe Microbizz ID of the team
todorefnumberReference for todo object.
todorefsArrayReference for all todos associated with the salescontract
contracttextlstringThe description of the quotation
contracthtmllstringThe description of the quotation as HTML. (readonly) 
startdatedate
expecteddatedate
phaseidnumberThe Microbizz ID of the phase
phasetextstringThe name of the phase
stateidnumberThe Microbizz ID of the state, readonly
statetextstringThe name of the state
personidnumberThe Microbizz ID of the responsible person
persontextstringThe name of the person
typeidnumberThe Microbizz ID of the type of the quotation
typetextstringThe textual name of the type
createdatedate
createtimetime
changedatedate
changetimetime

This object may include custom fields.

salescontractline


idnumberQuotation ID in Microbizz
contractidnumberThe Microbizz ID of the quotation
countnumberThe number of items to add
unitsstringThe units, eg. 'kg' or 'liters' or whatever
itemnumberstringThe product number
basepricenumberRead only
baseprice1numberWriteable baseprice, only allows a single value, not monthly values
costpricenumber
discountnumberThe discount in %
itemnamestringThe name of the product
notestring
issubscrbooleanIf the line is a subscription
createdatedate
createtimetime
changedatedate
changetimetime


serviceprotocol


idnumberProtocol ID in Microbizz
titlestring
qfidscollectionList of questionform IDs
serviceagreementidnumber
taskreqnumber1 if it is required to select a task; 0 if it isn't required; 2 if the app shouldn't ask at all
typestringEither "service" or "inspection"


stock


idnumberStock ID in Microbizz
titlenumberTitle of the stock
objecttypestringObject type the stock is attached to. Either customer or tool
objectidnumberId of the object the stock is attached to.


stodo


idnumberStodo ID in Microbizz
assignedbyuseridnumberThe ID of the user who created this reminder, may be 0
datedateThe date when the reminder should appear
timetimeThe time when the reminder should appear
descriptionstringDescription of the reminder
modcodestringWhat type of object this reminder refers to, may be empty if there is no relevant object
objectidnumberThe ID of an object that this reminder refers to


subscription

idnumberThe Microbizz ID of the subscription
customeridnumberThe Microbizz ID of a customer
teamidnumberThe Microbizz ID of a team
productnumberstringA product number used when invoicing
countnumberThe number of items to invoice
unitidnumberThe units of the items
titlestringThe name of the subscription
descriptionstringThe description of the subscription
periodnumberThe invoice period
nevermonthscollection[number]Don't invoice in these months
requisitionstring
pricenumberThe amount to invoice
discountnumber
inheritdiscountboolIf the discount should be taken from the customer
onseparateinvoicebool
aheadbool
startdatedateWhen the subscription starts
expiredboolThe subscription is expired
nextinvoicedatedate
expiredatedateWhen the subscription expires
todoidscollection[number]List of relevant tasks
toolidnumberThe ID of an equipment

todo

idnumberTodo ID in Microbizz
numberstringTodo number in Microbizz
workareaidnumberWorkarea ID. if set to an invalid workarea id. the id will be set to a random workarea to avoid todo failure.
workareatextstringA textual representation of the workarea (readonly)
customeridnumberCustomer ID.
customertextstringA textual representation of the customer name. (readonly)
iconscollection[number]A list of icon IDs to show on this todo.
iconlinkscollectionA list of links for the icons
checkpointscollection[number]A list of checkpoints to complete when checked in on this todo
titlestringTitle
secondary_textstringA secondary text describing this item.
addressstringAddress
address2stringSecond address-line
zipstringZip
citystringCity
countrystringCountry
descriptionlstringLonger description
htmldescriptionlstringLonger description, HTML formatted (from 2020 Q3); text specified in description will be converted to HTML
stateidnumberState of todo ID.
statetextstringA textual representation of the todo state. (readonly)
isclosedbooleanIndicates if todo is closed.
canclosebooleanIndicates if the todo can be closed from an external system, such as an mobile phone
isacceptedbooleanIndicates if todo is accepted as closed.
prioritynumberPriority.
estimatenumberEstimate in minutes.
timeusagenumberTime used in minutes.
useridnumberResponsible for todo. User ID.
closedby_useridnumberUser ID of user who closed this task.
usertextstringResponsible for todo in text. (readonly)
teamnumberTeam ID reference
subtodoscollection [number]ID of all subtodos to this todo (readonly)
parenttodonumberID of a parent todo to this todo, if non-0 then this is a subtask to another task
ispersonalbooleanIndicates that this todo belongs to the current user. (readonly)
isdeletedbooleanIndicates if the todo should be shown or not. If this is true, then the todo should be considered as deleted. (readonly)
isprivatebooleanTodo is private?
ispublicbooleanTodo is public?
requisitionstringRequisition number
startdatedateStart date.
deadlinedateDeadline.
closedatedateClosed date
personidnumberThe Microbizz ID of the person who is the contact person
persontextstringThe name of the person who is the contact person. This field is read-only.
temperaturenumberTodo temperature. (readonly)
alertradiusnumberGeofence radius (in meters) around this todo
longitudefloatGPS longitude
latitudefloatGPS latitude
invoicepolicystringSee the table below for the possible values
pricenumber
next_invoicedatedateDate for next invoice (if task is repeating)
tasktypenumber1=AdHoc; 2=Repeat, exact; 3=Repeat, loose; 5=Project
createdbynumberid of user which created the task.
createdatedateDate created
createtimetimeTime created
changedatedateLast change date
changetimetimeLast change time
qfonclosenumberFor app: Question form ID of question form to present on close of this todo.
qfoncheckoutnumberFor app: Question form ID of question form to present on checkout from this todo
qfoncheckout_requiredboolIf the question form in qfoncheckout is required or not
internalsubscriberscollection[number]List of user IDs of the subscribers
externalsubscriberscollection[number]List of person IDs of the subscribers
addressescollection[ address ]List of other addresses that are relevant
competencessetList of competences and the minimum required level for each competence
seperate_invoicebooleanSet to 1 if the task should be on a sep. inv. instead of on an inv. with other tasks for the same company
placenamestringThe name of the delivery place
additionaluseridscollection[number]List of IDs of additional users
contactnamestringName of contact person, if Microbizz is setup to not use the personid field
contactphonestringPhone of the contact person, if Microbizz is setup to not use the personid field
nextactiondatedateDate of next planning, readonly
nextactiontimetimeTime of next planning, readonly
lastactiondateDate of last planning, readonly
projectidnumberID of a project (only if the Project module is enabled; this is not the parenttodo)
projectgroupidnumberID of a projectactivity of type group
projecttextstringThe name of the project, see projectid
projectgrouptextstringThe name of the projectactivity, see projectgroupid
plannedtocollection[number]List of users for whom this task is planned
parenttodo_ns_numberstringThe task # of the parent task, if any
accord_isaccordboolIf this task uses accord, readonly
accord_minutesnumberAccord minutes, readonly
accord_totalvaluenumberTotal value of accord, readonly
accord_payednumberTotal value payed, readonly
accord_ratenumberAccord rate, readonly
accord_settledatedateDate of accord payment, readonly
invoice_customeridnumberThe Microbizz ID of the "payment company"

Values for invoicepolicy - these must be spelled exactly as below:

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)


This object may include custom fields.


todoitem


idnumberAn ID identifying this line of product use
todoidnumberTodo ID, where this product was used.
countfloatNumber of products used.
productnumberstringProduct number of the used product
linetextstringText of invoice line. Typically product name
unitpricenumberPrice pr. unit in lowest local currency (Typically danish ører). This is before any discount is applied.
statusnumberThe productusestate for this product use
orderidnumberCan be used for sorting
notestringA note attached to this product use
isdeletedbooleanIndicates if this product use is deleted
lockedbooleanIndicates if this product use is locked (ie cannot be modified or deleted)
invoicednumberThe invoiced status of the product use; either 0=not handled, 1=handled, 2= rejected
discountnumberA discount to be applied to the line. 0 = no discount, 100 = 100 % discount.
changedatedateLast change date
changetimetimeLast change time
useddatedateThe date when the product was used
toolidnumberTool ID
ediidnumberThe ID of an EDI
budgetareaidnumberThe Microbizz ID of the budgetarea
stockidnumberThe Microbizz ID of a stock
unitsstringThe abbreviation of the product unit
unitidnumberThe Microbizz ID of a product unit
costpricenumberThe costprice.
listpricenumberThe list price
useridnumberThe ID of the user who created this product use; 0 if not created by a user; read only
productgroupidnumberThe ID of the product group, see GetProductGroups


todostate


idnumberTodo state ID in Microbizz
titlestringTodo state title
isclosestatebooleanIs this state a closed state?
colorstringThe colour used for the state
accessboolIs the user allowed to select this state?
workareassetList of workarea IDs that allow this state
orderidnumberThe ordering ID, used for sorting the states for display

todostatehist


idnumberTodo state history ID in Microbizz
todoidnumberTodo id of task with this state.
stateidnumberTodo state ID in Microbizz
datedateThe date when the state changed
timetimeThe time when the state changed
titlestringThe name of the state


todotemplate


idnumberTemplate id in Microbizz
titlestringTemplate title
requirecustomerboolThis is 1 if the template requires that a customer is specified


tool


idnumberTool ID in Microbizz
namestringTool name
secondary_textstringA secondary text describing this item.
useridnumberUser ID of responsible user. Please note that the responsible user, is not always the same as the person carrying the tool.
usertextstringA textual representation of the responsible user. (readonly)
carrier_useridnumberUser ID of user carrying the tool. If this is 0 or not present, the tool is currently not carried. (readonly)
carrier_usertextstringA textual representation of the user carrying the tool. (readonly)
is_carrierbooleanTrue of the current user is the carrier. (readonly)
containedinnumberTool ID of the tool in which this tool is contained.(readonly)
containedintextstringA textual representation of the tool in which this is contained. (readonly)
is_installedbooleanIndicates if this tool is installed somewhere. (readonly)
installed_placetextstringA textual representation of where this tool is installed. (readonly)
numberstringTool number
codestringTool code
classstringTool class (readonly)
groupidnumberID of tool group
groupstringTool group (readonly)
makestringTool make
modelstringTool model
serialnumberstringTool serial number
nextservicedateDate of next service
lastservicedateDate of last service
isdeletedbooleanIndicate if the tool is deleted
longitudefloatGPS longitude of the last known position of this tool.
latitudefloatGPS latitude of the last known position of this tool.
createdatedateDate created
createtimetimeTime created
changedatedateLast change date
changetimetimeLast change time
qfonsetdownnumberFor app: Question form ID on question form to present on set down of this tool.
attachedcustomeridnumberCustomer ID
customeridnumberThe Microbizz ID of the “place of home”
todoidnumberTodo ID, if multiple then see todoids
todoidsarrayA collection of Todo IDs, the tasks that are currently associated with the equipment
barcodestringTool barcode
personidnumberID of a Person
persontextstringThe name of the contact person
iconscollection[number]The IDs of the custom fields of types "icon" or "icon url" that are set
iconlinkssetThe URLs for custom fields of type "icon url" that are set
partslistcollection[ partslist ]List of parts in the parts list for the equipment type
serviceprotocolscollection[number]The IDs of the service protocols that are available
stateidnumberThe ID of the current state
statetextstringThe name of the current state
servicestatusnumber1=serviced, 2=not serviced, 3=service soon, 4=past service
picturestringImage of tool as base64 encoded image data. Please note that only some commands return this field.
activebooleanIf the tool is active or not.

This object may include custom fields.

The servicestatus field is usually coloured: 1=green, 2=green, 3=yellow, 4=red,


toolstate


idnumberThe Microbizz ID of the state
titlestringName of the state
colorstringThe colour to use when displaying the state
accessbooleanIf the current user is allowed to select this state


tooltype


idnumberThe ID of the type
titlestringThe title of the type
allowregsboolIf the tool type allow registrations
allowedformssetList of IDs of the question forms that are allowed for this tool type
periodtypenumberThe service period type, see below
periodnumberThe service period, either days, hours or kilometers, depends on periodtype
classnumber

The periodtype field describe how often the equipment needs servicing. It can be either 0 (every N days), 1 (every N hours), 2 (every N kilometers) or 3 (every N days) or 100 (never). The value of N is specified in the period field. The difference between type 0 and 3 are only relevant for Microbizz.


This object may include custom fields.

thread

A thread is a collection of messages.

idnumberThe Microbizz ID of the thread
objecttypestring
objectidnumber
titlestringThe title of the thread
ispublicboolIf the thread should be shown on the extranet and elsewhere
isdeletedbool1 if the thread has been deleted
isunreadbool1 if the current user hasn't read all the messages in the thread
tagscollection[string]List of tags, each tag is a short text
lastmessagedatedateDate of last message
lastmessagetimetimeTime of last message
createdatedate
createtimetime
messagescollection[ tmessage ]
externalsubscriberscollection[number]List of person IDs of subscribers
internalsubscriberscollection[number]List of user IDs of subscribers


unit

A unit is information about how a company moves through a process.

idnumberUnit ID in Microbizz
titlestringTitle of the unit
customeridnumberID of a customer in Microbizz
customertextstringThe name of the customer
processidnumberID of the process in Microbizz
processtextstringName of the process
useridnumberID of the user in Microbizz
usertextstringThe name of the user
phaseidnumberThe ID of the phase in Microbizz
phasetextstringName of the phase
isclosedbool
startdatedateDate created
nextdeadlinedateDate created
finaldeadlinedateDate created
closedatedateDate created
createdatedateDate created
createtimetimeTime created
changedatedateLast change date
changetimetimeLast change time


user


idnumberUser ID in Microbizz
fullnamestringFull name
initialsstringInitials
usercodestringA number identifying the user, such as an employee-number
emailemailEmail / login.
passwordstringPassword. Please note that Microbizz only stores hashes of passwords, so when receiving a user type, the password field will always be blank.
mobilestringMobile phone number
mobilepinstringMobile pin code for the mobile app.
allowsmsbooleanIs the user allowed to SMS to the system
isactivebooleanIs the user active.
isadministratorbooleanIs the user an administrator.
licensetypestringEither Full or Mobile or Passive
createdatedateDate created
createtimetimeTime created
changedatedateLast change date
changetimetimeLast change time
usertypeidnumberThe ID of the user type
usertypetextstringThe name of the user type, eg. “Administrative personelle”
usertypecolorstringThe color used to indicate the user type
stdteamidnumberThe ID of the home team for this user
addressstringThe address of the user
address2stringged
zipstring
citystring
countrystringThe address of the user
birthdatedateBirthdate of user
hiredatedateThe date the user was hired
senioritydatedateThe senioritydate of the user
deactivationdatedateIf the user is deactivated this was the date of the deactivation.
competencesset

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

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

This object may include custom fields.

widget

idnumberWidget ID in Microbizz
typestringThe type of widget, currently only "iframe" is supported
linkstringFor "iframe" widgets this is the URL to display within an iframe

workarea

idnumberWorkarea ID in Microbizz
titlestringWorkarea title
categorystringWorkarea category
accessboolIf the user may select this workarea when registering time, editing tasks etc.


workplanentry

datedate
regtypeidnumberThe ID of this type of workplan entry
colorstring
titlestringTitle of this type of workplan entry, eg. 'Holiday' or 'Sick'
atworkboolean1 if the user is at work on this day
holidayboolean1 if this is a public holiday, eg. christmas
workdaydurationnumberDuration of work day, in minutes. May be 0.
busyminutesnumberMinutes of planned work/appointments on this date


workpool

idnumberWorkpool ID in Microbizz
titlestringThe title of the workpool
groupidnumberThe group ID of the responsible group/team
useridscollection[number]A list of user IDs
entriescollection[ workpoolentry ]A collection of workpool entries


workpoolentry

idnumberWorkpool entry ID in Microbizz
todoidnumberTodo ID in Microbizz
titletitleTitle of the Todo
deadlinedate
estimatenumberNumber of minutes
changedatedate
changetimetime
createdatedate
createtimetime

ticket

idnumberTicket ID in Microbizz
numberstringTicket number in Microbizz
accountidnumberAccount the ticket is assigned to
customeridnumberThe id of the customer the ticket belongs to
namestringThe name of the ticket
statenumberThe number of the state
statenamestringThe name of the state
stateidnumberThe id of the state
statetextstringThe description of the state
typeidnumberThe id of the type
typetextstringThe name of the type.
tagsarrayThe array of text tags
usernumberThe user who created the ticket
original_ticketidnumberThe ticket id the ticket may have been created from
ticketnumbernumberThe number of the ticket.
personidnumberThe person id of the person assigned to the ticket
phonenumberstringThe phone number of the person assigned to the ticket
closedatedateThe closing date.
closetimetimeThe closing time
closedby_useridnumberThe id of the user who closed the ticket.
createdby_useridnumberThe id of the user who created the ticket.
closedbooleanIf the ticket is closed
pendingbooleanIf the ticket is pending
emailstringThe email of the contactperson
lastestemailfromstringLast email to this ticket
lastestemailbodystringLast email text.
lastestemailsubjectstringLast email subject
latestemaildatedateLast email date of recieving.
lastnotestringLast note text
lastresponsiblechangedateDate of responsible change
lastmaildatedateDate of last recieved mail
laststatechangedateDate of last state change
lastnotetimetimeTime of last note
lastresponsiblechangetimetimeTime of last responsible change
lastmailtimetimeTime of last mail recieved
laststatechangetimetimeTime of last state change.
lastcommtimetimeTime of last communication
usersarrayArray of relevant users for the ticket.
timesincelaststringTime for last communication
todosarrayArray of tasks assigned to this ticket.
registrationtimenumberTime in minutes of how much is registered.
invoicedtimetimeThe of minutes invoiced so far.
invoicepolicystringThe policy used for invoicing. based on the customer.
sourcestringThe text the number displays.
sourceidnumberA number indicating where the ticket was from.
descriptionstringThe full description of the ticket.
createdatedateDate of creation
createtimetimeTime of creation
changedatedateDate of latest change.
changetimetimeTime of latest change.