Complex types (part 2: I-R)

id

number

Icon ID in Microbizz

title

string

Icon title

data

binary

The binary data of a PNG representing the icon

md5sum

string

MD5 sum of the data

id

number

Image tag ID in Microbizz

tag

string

The image tag

id

number

ID of the invoice

number

string

The Invoice number

requisition

string

customerid

number

The ID of a Customer in Microbizz

customertext

string

The name of the Customer

userid

number

The ID of a user in Microbizz

usertext

string

The name of the user

sellerid

number

The ID of the user who is the seller

sellertext

string

The name of the user who is the seller

team

number

The ID of the team to whom the invoice belongs

fromname

string

Address

fromaddress

string

fromaddress2

string

fromzip

string

fromcity

string

fromcountry

string

fromperson

string

fromemail

string

toname

string

Address

toaddress

string

toaddress2

string

tozip

string

tocity

string

tocountry

string

toperson

string

toemail

string

additionaltoemail

collection[string]

Additional emails

toean

string

deliveryname

string

Address

deliveryaddress

string

deliveryaddress2

string

deliveryzip

string

deliverycity

string

deliverycountry

string

additionaltext1

string

Text that describes the invoice

additionaltext2

string

Text that describes the invoice

totalsum

number

The total sum of the invoice lines

payment_currency

string

remainder

number

bookeddate

date

paiddate

date

duedate

date

invoicedate

date

paymentterms_out

number

layout_out

number

paymentterms_in

number

layout_in

number

isposted

bool

ispayed

bool

iscredit

bool

iserror

bool

If this invoice failed

errortext

string

The error text from when the invoice failed

bouncetext

string

theirref

string

remoteid

string

nonstick

bool

createdate

date

(readonly)

createtime

time

(readonly)

changedate

date

(readonly)

changetime

time

(readonly)

id

number

ID of the invoice line

customerid

number

ID of the customer to which this line should be invoiced

related_customerid

number

ID of the customer which this line regards. This can differ from the customerid if you redirect your invoicing from one customer to another.

invoiceid

number

The ID of an invoice

todoid

number

If the invoice line can be attached to a todo then this holds the ID of the todo

date

date

Date of the invoice line ie. the date printed on the invoice.

invoicedate

date

The date the line is sent to invoicing, ie. the date the “button” was pressed.

referencedate

date

The reference date for the line. If this line concerns a specific registration or product use, this will be the date this was added.

linetext

string

Text of the invoice line

productstatus

number

The product use status for the product behind this invoice line

stock

number

A reference to a stock from where the product is removed.

discount

number

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

itemnumber

string

Item number of the invoice line (product number)

count

number

Item count of the invoice line

price

number

Price per unit in lowest local currency (typically Danish ører). This price is before any discount.

units

string

The product unit

createdby

number

ID of the user who created this line

reference

number

The type of object that created this line; read-only.

1=User, 2=Equipment, 3=Invoice fee, 4=EDI, 5=EDI+, 6=Subscription

referenceid

number

The Microbizz ID of the object described by the field “reference”; read-only

id

number

ID of the stage

todoid

number

ID of the task to which this stage applies

category

string

Description

position

string

Short text

value

number

previous

number

%

current

number

%

previous_level

number

current_level

number

note

string

changedate

date

changetime

time

createdate

date

createtime

time

id

number

Id of MA event.

eventtitle

string

Title of event

id

number

List id in Microbizz

title

string

List title

customerid

number

To which company is this receiver related.

personid

string

If 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

name

string

The name of the receiver

email

string

The email of the receiver

objecttype

string

The type of object this mainpage is used with

boxes

collection[ Complex types#mainpagebox ]

List of boxes to display

box

string

This specifies what type of box this is, some types are built in, some refer to a column group or a widget

title

string

The title of the box

iscolumngroup

boolean

1 if the box contains a column group

columngroupid

number

The ID of a column group (if iscolumngroup is set)

iswidget

boolean

1 if the box is a widget, is is not valid for iscolumngroup and iswidget to both be set

widgetid

number

The ID of a widget (if iswidget is set)

id

number

Refers to an ID in another list

md5sum

string

The MD5 sum of data in another list

id

number

The MB ID of the message

userid

number

The MB ID of the User who sent the message

usertext

string

The name of the user

message

lstring

The message text

date

date

The date of the message

time

time

The time of the message

confirmation

number

0=no confirmation, 1=pending confirmation, 2=confirmed

read

boolean

1 if the message has been read

modcode

string

An optional string which describes which type of object this message relates to

objid

number

The ID of the object that this message relates to

id

number

The MB ID of the message

threadid

number

The MB ID of a Complex types#thread

userid

number

The MB ID of the user who wrote the message, should be 0 if it was a person

personid

number

The MB ID of the person who wrote the message, should be 0 if it was a user

authorname

string

The name of the user/person who wrote the message

changedate

date

changetime

time

isunread

boolean

If the message is unread by the current user

message

lstring

The message text, may include HTML tags

documentids

array

List of Microbizz IDs of the documents that are attached, see GetDocumentByID

id

number

The MB ID of the message

message

lstring

The message text, this is actually HTML

receivers

collection[number]

List of IDs of users to receive the message

conversationid

number

The MB ID of a conversation

userid

number

The ID of the user who wrote the message

usertext

string

The name of the user who wrote the message

date

date

time

time

isunread

boolean

If the message is unread

id

number

Id of the note

objecttype

string

To which object is this note attached. “customer” or “task”.

objectid

number

Either customer ID or todo ID

userid

number

Id of user from where this note originated

usertext

string

Name of the user from where this note originated. (readonly)

receiverid

number

Id of user where this note is going to

receivertext

string

Name of user where this note is going to. (readonly)

date

date

Date of the note

time

time

Time of the note

text

lstring

The text of the note

id

number

ID of the notification

assignedby

number

The ID of the user who caused this notification, or 0 if it was a person

assignedby_personid

number

The ID of the Complex types#person who caused this notification, or 0 if it was a user

text

string

The notification text, may include links and HTML tags

date

date

The date of the notification

time

time

ispublic

bool

1 if the notification should be marked as “public”

isread

bool

1 if the notification has been read/dismissed

objecttype

string

An object type indicating what object the notification relates to

objectid

number

message_threadid

number

The ID of the related thread, if objecttype is message

partid

number

The ID of the parts list; IDs are only unique within a tool type.

productnumber

string

A product number.

productname

string

The name of the product.

count

number

Number of items expected to be used.

units

number

The ID of a unit.

toolref

number

The Microbizz ID of a tool

count

number

partid

number

The partid from a Complex types#partslist

id

number

Person ID in Microbizz

firstname

string

Person first name

lastname

string

Person last name

address

string

Person address

address2

string

Person address2

zip

string

Zip

city

string

City

country

string

Country

phone

string

Phone no.

mobile

string

Mobile.

fax

string

Fax no.

www

string

Web address

email

email

Email.

secondary_text

string

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

createdate

date

Date created (readonly)

createtime

time

Time created (readonly)

changedate

date

Last change date (readonly)

changetime

time

Last change time (readonly)

typeid

number

The ID of the person type in Microbizz, see GetPersonTypes

typetext

string

Textual representation of the person type

isdeleted

bool

If the person is deleted/deactivated

requestconsent

bool

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

team

number

reference to the team the person is a part of.

id

number

Person type ID in Microbizz

title

string

Name of the person type

color

string

The colour to use for this person type

code

string

A one-character code denoting the type

id

string

Id of destination.

destination

string

Term of destination

productnumber

string

The product number

text

string

Product description

image_url

string

URL of an image of the product

best

set

The best price found, if any, the set contains the fields: price, list_price, supplier_name, supplier_short, supplier_id, supplier_logo

preferred

set

The preferred price, if any, see the field best for details

worst

set

The worst price found, if any, see the field best for details

id

number

The Microbizz ID

modcode

string

The module to which this belongs

sysref

number

The ID of an object in the module

isdeleted

boolean

1 if the procedure has been deleted and should not be shown

title

lstring

The title of this procedure

text

string

The text for the procedure

visible4

collection[number]

id

number

Id of this production entry in Microbizz

userid

number

Who is going to work on the todo? User ID

todoid

number

Which todo? Todo ID

todotext

string

A textual representation of the todo. (readonly)

secondary_text

string

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

date

date

Date of work.

time

time

Time of work.

place

string

Place of work. DEPRECATED.

durationinminutes

number

Duration of work in minutes.

locked

bool

If the production is locked

visited

bool

If the production has been visited by the user (readonly)

activitycolor

string

The colour to use when displaying this entry

createdate

date

The date when this was created (readonly)

createtime

time

The time when this was created (readonly)

displaytime

string

For normal planning this holds starttime and endtime (eg. “09:00 - 12:00”); for full day planning it holds the string “Full day” or similar

type

boolean

1 if this is a full day planning, 0 if it is a normal planning

id

number

Internal Microbizz product ID

productnumber

string

The product number

barcode

string

Barcode number

group

string

Name of product group. Microbizz automatically creates and deletes these groups on demand. This field is deprecated and should not be used. Use the field productgroupid instead.

subgroup

string

Name of product subgroup. Microbizz automatical creates and deletes these subgroups on demand.

title

string

Product title

price

number

Product base price in lowest local currency. (Typical danish ører)

costprice

number

Product cost price in lowest local currency. (Typical danish ører)

isdeleted

boolean

Indicates if this product is deleted

sparepart

boolean

1 if this is a sparepart

supplierid

number

favorite

boolean

1 if this is one of the user's favourite products; use AddFavoriteProduct to update this

secondary_text

string

This is used as the search text

units

string

The abbr. of the product unit (readonly)

unitid

number

The ID of the product unit

productgroupid

number

The ID of the product group, see GetProductGroups

id

number

Internal Microbizz product unit ID

title

string

The name of the unit, eg. 'Liters' or 'meters'

abbr

string

The abbreviation or the title, eg. 'l' or 'm', max 5 chars

id

number

Internal Microbizz product use status ID

title

string

The name of the status

color

string

Format is '#RRGGBB'

default

bool

If this should be the default product use state

showinapp

bool

If this should be displayed for product uses

useinapp

bool

If this should be selectable

id

number

Internal Microbizz product use status ID

number

number

The project #

workareaid

number

Internal Microbizz workarea ID

workareatext

string

Name of the workarea

customerid

number

Internal Microbizz customer ID

customertext

string

Name of the company

title

string

The name of the project

description

string

address

string

address2

string

zip

string

country

string

stateid

number

Internal Microbizz project state ID

statetext

string

isclosed

bool

priority

number

estimate

number

Estimate in minutes

userid

number

Internal Microbizz user ID

usertext

string

The name of the user

team

number

Internal Microbizz team ID

isdeleted

bool

ispublic

bool

requisition

string

startdate

date

deadline

date

closedate

date

projecttype

number

Internal Microbizz project type ID

personid

number

Internal Microbizz person ID

persontext

string

The name of the contact person

createdby

number

The ID of the user who created this

longitude

float

latitude

float

invoicepolicy

number

Internal Microbizz invoicepolicy number

price

number

createdate

date

(readonly)

createtime

time

(readonly)

changedate

date

(readonly)

changetime

time

(readonly)

id

number

Internal Microbizz projectactivity ID

title

string

The name of the activity

projectid

string

Internal Microbizz project ID

projecttext

string

The name of the project

objecttype

string

The type of object that is attached to this activity, either todo or event or empty

objectid

number

The ID of the object

parentid

number

The ID of the parent activity or 0

parenttext

string

The name of the parent

startdate

date

enddate

date

duration

number

Duration in days

estimate

number

Estimate in minutes

progress

number

Progress from 0 - 100

createdate

date

(readonly)

createtime

time

(readonly)

changedate

date

(readonly)

changetime

time

(readonly)

id

number

The Microbizz ID of the project template

title

string

The title of the project template

type

number

The ID of the project type, see GetProjectTypes

id

number

The Microbizz ID of the project type

title

string

The title of the project type

color

string

Color for the project type, format is "#RRGGBB"

id

number

ID of this specific registration in Microbizz.

isdeleted

boolean

Indicate if this registration is a deleted registration.

userid

number

The user id of the user making the registration.

date

date

Date of registration

locked

boolean

It indicates if a registration is locked. A locked registration cannot be edited or deleted.

approved

boolean

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.

approvedby

int

the userid of the user which approved the registration.

gpslock

boolean

1 if the GPS cordination was within 500 m of the expected location

registrationtext

string

This is a textual representation of the registration, used to display the registration. (readonly)

todoid*

number

Which todo? Todo ID

customerid*

number

Which customer? Customer ID.

internalid*

number

Which internal registration? Internal registration ID, see GetInternalRegistrations

workareaid

number

Workarea ID

starttime

time

Time the registration started.

minutes

number

Number of minutes worked.

note

string

An optional note to attach to the registration.

star1

boolean

Star 1

star2

boolean

Star 2

star3

boolean

Star 3

star4

boolean

Star 4

longitude

float

GPS longitude from where the user performed the registration

latitude

float

GPS latitude from where the user performed the registration

toolid

number

Tool ID

costprice

number

The costprice of the registration per hour

onetime_costprice

number

The onetime cost price of the registration (if any). Typically this is from custom registrations. Read-only.

total_costprice

number

The total cost price of the registration (which is costprice x minutes/60 + onetime_costprice). Read-only.

src

number

Subsystem that generated this entry: 1=manual, 2=automatic, 3=checkout, 4=ticket

srcid

number

Depends on src, can be ID of a checkin or ID of a ticket

invoiced

number

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

customregistrations

set

If 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.

id

number

ID of this internal registration

text

text

The title of this external registration