Misc commands

GetMobileAppSettings

A collection of functions and settings used by the mobile apps to configure itself.

Keyword	Function
AllowReposition	When checking in far from an objects location, the user should be allowed to move the position of the object to their current position.
AutoCheckOut	Allows Automatically checkout if users have been checked in for longer than their normal workday plus a little extra.
CalendarCreate	Create calendar appointments
CalendarView	Access to the calendar module
CalendarHideOtherUsers	Same as ProdplanHideOtherUsers
CallLogging	Deprecated
Calls	Access to the sales module
CheckIn	Allow checkin via app (always set)
CheckInOnEvents	Allow to check in on events (which will check in on the customer assigned to the event)
CheckInOnProduction	Allow to check in on planning (which will check in on the planned task)
Checkout_FormRequired	When checking out, any checkout form is mandatory to fill in.
Checkout_Registration_None	When checking out, a time registration should never be posted.
Checkout_Registration_Optional_Off	When checking out, the user should be able to select if a time registration should be made. This should default to off.
Checkout_Registration_Optional_On	When checking out, the user should be able to select if a time registration should be made. This should default to on.
Checkout_Registration_Required	When checking out, a time registration is mandatory.
CustomersCreate	The user may create new CRM objects from the app.
CustomersDraw	The user is allowed to draw map objects on customers.
CustomersEdit	The user may edit CRM objects from the app.
CustomersFiles	Files are accessible on CRM objects.
CustomersFloorplan	Deprecated
CustomersForms	Allow filling forms on customers.
CustomersNotes	Access to customer notes.
CustomersPhoto	User may take photos on CRM objects.
CustomersProcedures	Procedures are visible on CRM objects.
CustomersView	Access to the CRM module
CustomRegistrations	If Custom registrations are allowed
DayCheckin	Allow the user to check in on the day (deprecated?)
Drive	Deprecated
EnableNFC	Enable NFC functionality
LimitNumObjects	The app should use the special strategy for reduced object count
LocationLogging	The app should passively track the user location.
ManyProducts100K	This is set if there are more than 100000 products in the DB, the app may use this to adjust how it synchronizes products
ManyProducts10K	This is set if there are more than 10000 products in the DB (but less than 100000)
NewMessages	Enable the new message system
NewNotes	Enable the new note system
NoCustomerCheckin	Checkin isn't allowed on CRM objects
NoCustomerRegistration	It isn't allowed to register time on CRM objects
NoEditTimeAtCheckout	Time is not allowed to be edited when checking out
NoEditTime	It is not allowed to edit/delete own registrations - but it is still allowed to create registrations
CustomersHideProspects	It isn't allowed to show customer prospects in App
NoProximityAlert	If the option named “Alert when close to a task or company?” isn't set, then this keyword is present
NoTimeOverlap	Do not allow hour registrations to overlap.
NotePost	Allow to post notes (always present)
PersonEdit	Allow to edit person
PersonView	Access to the person module
PersonalDocuments	Allows to see personal documents (which are files under the current user)
Project2Enabled	Access to the process module (unused?)
PlaceOrder	Access to the sales module
ProdplanHideOtherUsers	If the production plan/calendar should show other users
ProdplanAhead<n>	Limits the number of days one should be able to look forward in the production plan where <n> is the number of days; if the value is 0 or not specified then it should be considered to mean "forever"
ProdplanReveal<clock>	When is the next day revealed in the production plan, where <clock> is the timestamp.
ProdplanView	Access to the planning module
ProdplanEdit	Allow editing a plannings
ProductEdit	Allow product edit
ProductView	Deprecated
QRLogging	Enables the QR scanner
Registration_Clock	Registration is with time stamps instead of minutes, so 12:00-14:00 instead of 120 minutes.
Registration_Star1	The blue star should be present
Registration_Star2	The yellow star should be present
Registration_Star3	The green star should be present
Registration_Star4	The red star should be present
Registration	The user should be able to register time
RegistrationMidnightToFirstDate	When registering time over midnight, the selected date should be the first day ie. 01-01-2000 23:00:00 - 01:00:00
RegistrationMidnightToSecondDate	When registering time over midnight, the selected date should be the second day ie. 02-01-2000 23:00:00 - 01:00:00
RegistrationOnClosedOff	Do not allow registrering time on a closed task
RegistrationOnClosedAlways	Allow registrering time on a closed task
RegistrationOnClosedUntilMidnight	Allow registrering time on a closed task, but only on the date when the task was closed
Stock	Use stock functions
StockRequired	Stock is required to be selected when adding a product use.
TodoChangeState	Allow changing status on task
TodoCloseDays<N>	How long after task closure will MB keep sending info about the closed tasks, f.ex. "TodoCloseDays90" for 90 days; if N=10000 then MB will not send closed task. Notice that the setting only applies if the app sends "ignoreclosed" in the GetTodosByLastChange API call.
TodoCreate	Allow creation of new tasks
TodoDraw	The user is allowed to draw map objects on tasks.
TodoEdit	The user may edit todo objects from the app.
TodoFiles	Files are accessible on task objects.
TodoForms	Allow filling out forms.
TodoHideAll	Don't show the “all tasks” tab in app v2
TodoHideProjects	Don't show projects
TodoNotes	Allow notes on tasks.
TodoPhoto	User may take photos on task objects.
TodoPlan	Allow planning the task.
TodoPlannedTabs	Show planned tab in app v2
TodoProducts	Allows product use on tasks.
TodoShowProjectFiles	Show project files amongst the other files for a task
TodoTeamTabs	Show tabs for each team (in app v2?)
TodoView	Access to the task module
ToolCreateTask	Allow creating tasks on tool
ToolDetach	Allow to detach tool.
ToolDraw	The user is allowed to draw map objects on tool.
ToolEdit	The user may edit tools.
ToolFiles	Files are accessible on tool objects.
ToolForms	Fill forms on tools
ToolInstall	Allow installing tool
ToolNotes	Allows notes on tools.
ToolPhoto	User may take photos on tool objects.
ToolPlaceOfHome	Allow to change the tool place of home.
TodoProductUseSearch	If you can search for productuse
TodoProductUseCreate	If you can create new productuse
TodoProductUseCreate	If you can create edit existing productuse
TodoProductUseDelete	If DeleteProductUseByID will delete the product use
TodoProductUseOffset	If DeleteProductUseByID will offset the product use
ToolChangeState	Change state of tools
ToolRegistrations	Allow registration of time on tools
ToolTakeOthers	Allows to take tools carried by others
ToolTake	Allows to book tool.
ToolWriteNFC	Allow writing of tool NFC tags.
ToolsManualPickup	Can pick up tools (always on if tool module available)
ToolsSetDownOnCheckout	All carried tools should be set down when checkin out
Tools	Access to tool module
UserEdit	If the user is allowed to edit details about himself/herself
VirtualFoldersREADONLY	If virtual folders should be readonly; virtual folders are f.ex. task folders that are shown for the customer, or subtasks folders that are shown on a project

Input

permissions

number

Set to 1 to also read the permissions

Output

functions	collection[string]	A collection of functions to enable - see the list above
permissions	set	A set of module names and the list of enabled permissions for each module
settings	set	Various settings
defaultstock	number	MB ID of the default stock
minutesteps	number	Granularity when selecting a duration in minutes; default 5

The following settings may be provided in the settings field:

imagenodateandlocation

boolean

If 1 then don't insert time+date+location in the photos

GetAccessToken

Get an access token that can be used with endpoint_token.php instead of using endpoint.php.

Input

None

-

Output

accesstoken	string	An access token that should be passed to endpoint_token.php
expiredate	date	When then token expires
expiretime	time	When the token expires

LogOut

Log out of the system, should be called by the app when the user logs out. The main purpose is to clear the push token.

Input

pushtoken

string

The push token that was last sent from this app

Output

None

Log

Log a string to the Microbizz API log

Input

text	string	String to log
mail	boolean	Set to true to send the log to drift@microbizz.dk

Output

None

-

Configuration

GetWorkareas

Get all Microbizz workareas. All workareas are returned, and replaces earlier workareas.

Input

None

-

Output

workareas

collection[ workarea ]

A collection of all work areas in the Microbizz system.

GetCustomAppLinks

Get a list of custom links to inject into the app. This allows server side content/functionality to be displayed in the app. These should be accessible somewhere, preferable via an icon. The URL should be displayed in a browser window within the app.

Input

None

-

Output

Collection of:

icon	number	Et tal der angiver hvilket ikon app'en skal vise: 1 – Start (huset) 2 – Virksomheder 3 – Opgaver 4 – QR 5 – Timer 6 – Person 7 – Opkald 8 – Udstyr 9 – Plan 10 – Bruger
title	string	Title of icon
url	string	Link to functionality

GetCustomFields

Get info about all Custom fields.

Custom fields are fields that Microbizz users may add to various objects, like todo or customer. There are several types of custom fields, see Custom fields.

Input

None

-

Output

fields

set

The name of each item is a module code/object type, and the value is a collection of customfields

GetColumnGroups

Get info about column groups. A columngroup specifies the content of a box that is to be displayed in the app.

Input

None

-

Output

columngroups

collection[object]

List of column groups

Each column group contains

id	number	The ID of the column group
objecttype	string	The type of object this group describes
title	string	The title of the group
purpose	number	See below
columns	collection[string]	LIst of the fields included in the group
titles	collection[columntitle]	The titles of the columns, may include other info
appicons	collection[appicon]	The app icons to use

objecttype can be either of "todo", "person", "users", "tools", "customers", "prodplan", "calendar", "todo_productuse", "sales_product" or "project".

purpose indicates under which circumstances the group should be used: 0 - anytime, 1 - object main page, 2 - search text, 3 - sub object.

columns contain a list of field names. See 3-parts notation below.

appicons is a collection of objects which specify the icons to use with the column; each object has with the following fields:

icon	the name of an icon to use
column	the name of the column for which this icon should be used

titles is a collection of objects which specify the titles of the columns, it may also include other info about the column; each obhect has the following fields:

title	the title of this column
column	the name of the column for which this title should be used
iscustomfield	optional, is 1 if the column is a custom field
customfieldtype	the type of the custom field, only if `iscustomfield` is set to 1, seeCustom fields for details about the types
customfieldsubtype	the subtype of the customfield, only if `iscustomfield` is set to 1
type	the type of the field, currently this is only relevant for Ventu

3-parts notation

Some object types may refer to fields from other object types, f.ex. the planning (object type = prodplan) may refer to fields from the associated task. This is specified by a field name consisting of 3 parts separated by . (full stop). F.ex. if a column group for prodplan (see prodplanentry) includes the field todoid.todo.customertext then this means that the value in field todoid in the prodplanentry is the ID of an object of type todo, and you should use the field customertext from the todo object.

So the first part (todoid) refers to a field in the object for which the column group applies. The second part (todo) indicates another object type. The third part (customertext) indicates a field in the other object type - this is the value to display.

GetMainPages

Get info about which boxes to display on an object main page. See the section Mainpages on this page for details about the boxes.

Input

None

-

Output

mainpages

collection[ mainpage ]

List of main pages

There is one mainpage object for each of the object types todo/customers/person/tools.

GetAllWidgets

Get info about which widgets are available; widgets are referenced by main pages, see mainpagebox.

Input

None

-

Output

widgets

collection[ widget ]

List of widgets

GetCheckpoints

Get all Microbizz cheeckpoints. All checkpoints are returned, and replaces earlier checkpoints.

Input

None

-

Output

checkpoints

collection[ checkpoint ]

A collection of all checkpoints in the Microbizz system.

Checkpoints are saved when calling DoCheckOut or DoCheckOutForUser.

GetIcons

Get all Microbizz icons. All icons are returned and replaces earlier icons.

Input

md5sums	collection[ md5list ]	The known MD5 sums of icons for custom fields etc
appicons	collection[md5list]	The known MD5 sums of app icons

Output

icons	collection[ icon ]	A collection of all icons in the Microbizz system.
appicons	collection [appicon]	A collection of all the app icons; only included if `appicons` is set in the input

An appicon object contains the fields id, data and md5sum. The id field holds the icon name, eg map1.png; the same name/id should be used in the md5list in the input.

No image data will be transferred for the icons (or app icons) which match the supplied MD5 sums.

GetCurrentUserID

Get the user ID of the current user.

Input

None

-

Output

userid

number

The user id of the current user.

SetUserPassword

Set the password for the current user. Optionally also set name and mobile phone no.

Input

password	string	The MD5 sum of the new password; must be lowercase.
oldpassword	string	The MD5 sum of the old password; must be lowercase.
fullname	string	The full name of the user, eg. “Bill Clinton”
mobile	string	The mobile phoneno of the user, eg. “+4512345678”

Output

None

-

Workplan

GetWorkplanForDates

Get the workplan for the current user

Input

fromdate	date	-
todate	date	-
userid	number	The MB ID of a user; if not specified then return data for the current user
busy	boolean	If 1 then include `workdayduration` and `busyminutes` fields in the result

Output

workplanentries

collection [ workplanentry ]

The workplan

GetWorkplanByLastChange

Get workplan entries changed after a given date.

Input

field	type
changedate	date	last time it was changed.
changetime	time	(optional) the last time it was changed.
busy	boolean	If 1 then include `workdayduration` and `busyminutes` fields in the result, this is slow!

Output

workplanentries

collection [ workplanentry ]

The workplan

GetPastRegistrations

Get the daily worksheets and workplan for the current user.

Input

startdate	date	-
enddate	date	-

Output

weeks	set	The worksheets, grouped by weeks and dates
workplan	collection [workplantype]

A workplantype contains the fields id,color and title.

The weeks set contains an entry for each week in the period; the field is date of the monday in the week and the value is another set containing the fields following fields:

Values in the weeks set:

field	type
`weekno`	number	week number
`end`	date	date of the sunday in the week
`hours`	number	total number of minutes registered by current user in the week
`dates`	set	The fields are the dates in the week, the values are yet another set, see below

Values in the dates set:

field	type
`hours`	number	total number of minutes registered by current user on the date
`workplan`	number	the workplan registration type for the date, see the `regtypeid` field in workplanentry
`isopen`	boolean	1 if the worksheet for the date is open, 0 if it is is closed

Notes

Notes are deprecated, use the message commands instead.

GetNotesByLastChange

Get the notes from beginning to end.

field	type
objecttype	string	the type of parent. example 'todo'
objectid	number	the id of the parent. Example the todo it's connected to.
changedate	date	last time it was changed.
changetime	time	(optional) the last time it was changed.

GetNotes

Get all notes belonging to the specified object

Input

objecttype	string	The type of the object for which to retrieve notes. Either “customer” or “todo”
objectid	number	The id of the object for which to retrieve notes.

Output

notes

collection[note]

The notes

PostNote

Post a note. A note ID must be provided, even though it is ignored. It can be set to 0.

Input

note	note	The note to post
message	set	If the note should also spawn a message

Output

note

The note as it was created in the system.

The message set holds two fields: remoteid which is the user ID of the receiver, and confirmation which determines in the message requires confirmation.

There are two special values for remoteid: 1000000000 - sends to the responsible user for whatever object the note belongs to, and 1000000001 - sends to the next user who checks in on the task or customer that the note belongs to.

Search

SearchProvider

Search Microbizz for customers, person, todo, tool, product

Input

search	string	The search term
objecttypes	collection[string]	Which objects to search, you may call this field "modcodes" instead, see below for a list of possible objecttypes
reference	mixed	See below
textsearch	bool	Set to 0 to return just the IDs of the matching objects, set to 1 to return also a string that describes the object (typically the object name)

Output

objects

set

The keys are the object types, the values are sets of the matching results

Object types

objecttype	fields that will be matched	meaning of the field "reference"
person	firstname, lastname, address, address2, zip, city, country, phone, email	Either: A company ID, to find only persons associationed with that company, or A set with two fields: modcode, sysref where modcode must currently be the string "customers" and sysref is then a company ID
customers customer	name, customernumber, vat, publicid, address, address2, zip, city, country, id, phone, email A fuzzy search is also performed, so that if the search term looks like the name then it is considered a match
todo	name, number, address, address2, requisition
product	title
tool	name, make, model, serialnumber If company matches the search term then any equipment that belongs to the company will also match

Stock

GetStocks

Get all Microbizz stocks. All stocks are returned, and replaces earlier stocks.

Input

None

-

Output

stocks

collection[ stock ]

A collection of all stocks in the Microbizz system.

CreateStock

Create a new stock and optionally attach it to an object

Input

stock

The stock to create. (Id is ignored)

Output

stock

The stock that was created

DeleteStock

Deletes a stock and remove assignment from it, from every user that was assigned.

Input

stockid

number

ID of the stock to delete.

Output

None

-

AssignStockToUser

Assigns a stock to a user as the users default stock. If no stockid is provided any default stock is removed from the user instead.

Input

userid	number	ID of the user to assign / deassign.
stockid	number	ID of the stock to assign or empty to deassign.

Output

None

-

Depots

AddDepotOrder

Add a depot order based on a depot inventory.

Input

customerid	number	The ID of the company for which the depot inventory was done
order	collection[doline]	The actual depot inventory
orderdate	date	When the depot inventory was done
ordertime	time	When the depot inventory was done

Output

None

-

Each line in order is a set containing the fields depotitemid and ordercount.

CreateUpdateDepotOrderLine

Create a new depot order line, or update an existing.

Input

line

Complex types#depotorderline

Output

line

depotorderline

GetDepotsByLastChange

Get the depots that have changed recently.

Input

changedate	date	-
changetime	time	-

Output

depots

collection[depot]

A list of the depots that have changed

Files

UpdateDocument

Update the data for a file.

Input

documentid	number	The internal Microbizz ID of a file/document
filedata	string	Base64 encoded binary data
title	string	New title of the file
filename	string	New name of the file, notice that the extension (eg. .jpg) must be the same as the existing file

Output

document

A document object

GetDocumentsByModcodeAndID

Get all documents for a modcode+ID.

Input

modcode	string	A modcode
objectid	number	An object ID
inclthumbs	bool	True to include thumbnails
inclfolders	bool	True to include folders

Output

documents	collection [ document ]	The documents present on the object
folders	collection [folder]	The folders present on the object

GetImageTags

Get all Microbizz image tags. All tags are returned and replaces earlier tags.

Input

None

-

Output

imagetags

collection[imagetag]

A collection of all image tags in the Microbizz system.

GetDocumentByID

Get a specific document providing a document ID

Input

documentid

number

The id of the document

Output

document	document	The document object
data	binary	The binary data of the document itself

GetDocumentsInfoByLastChange

Get documents that have changed since a given date.

Input

changedate	date	The change date
changetime	time	The change time
version	number	This should be 2, version 1 most likely crashes
resumekey	string

Output

docs	collection[document]	The documents
resumekey	string

GetPersonalDocuments

Get all personal documents of the current user

Input

inclfolders

bool

True to include folders

Output

documents	collection [document]	The personal documents
folders	collection [folder]	The folders in the personal documents area

AddFileToPersonalDocuments

Add a file to the personal documents for the user.

Input

filename	string	The name of the file, eg. “MyDocument.PDF”
filedata	binary	A binary stream. base64_encode(Required)
title	string	A file title (not a file name)
folder	string	The path of the folder, eg. "FilesFromAPI/Diagrams"
userid	number	The users of id of the user who should receive the file. Default is the logged in user.

Output

None

-

AddPhotoToPersonalDocuments

Add a photo file to the personal documents for the user.

Input

title	string	A file title (not a file name)
imagedata	binary	A binary stream containing photo data in jpeg format. base64_encode(Required)
createdate	date	When the photo was taken
createtime	time	When the photo was taken
tags	collection [number]	An optional collection of tags to attach to this image (tag IDs)
documentid	number	Optional ID of an existing file, to update the file instead of creating a new file

Output

document

A document object

AddPhotoToCustomer

Add a photo file to a specified customer.

Input

title	string	A file title (not a file name)
imagedata	binary	A binary stream containing photo data in jpeg format.
customerid	number	reference to the customer.
createdate	date	When the photo was taken
createtime	time	When the photo was taken
tags	collection [number]	An optional collection of tags to attach to this image (tag IDs)
documentid	number	Optional ID of an existing file, to update the file instead of creating a new file
folder	number	Optional ID of a folder, the image should be placed in.
onxnet	boolean	if image is public for extranet.
longitude	float	Optional geolocation longitude of the phone at upload.
latitude	float	Optional geolocation latitude of the phone at upload.
comment	string	Optional comment on the image.
category	number	Optional Reference to existing image's file category.
subcategory	number	Optional Reference to existing image's file subcategory.

Output

document

A document object

AddPhotoToTodo

Add a photo file to a specified Task.

Input

title	string	A file title (not a file name)
imagedata	binary	A binary stream containing photo data in jpeg format.
todoid	number	reference to the task.
createdate	date	When the photo was taken
createtime	time	When the photo was taken
tags	collection [number]	An optional collection of tags to attach to this image (tag IDs)
documentid	number	Optional ID of an existing file, to update the file instead of creating a new file
folder	number	Optional ID of a folder, the image should be placed in.
onxnet	boolean	if image is public for extranet.
longitude	float	Optional geolocation longitude of the phone at upload.
latitude	float	Optional geolocation latitude of the phone at upload.
comment	string	Optional comment on the image.
category	number	Optional Reference to existing image's file category.
subcategory	number	Optional Reference to existing image's file subcategory.

Output

document

A document object

AddPhotoToTool

Add a photo file to a specified tool.

Input

title	string	A file title (not a file name)
imagedata	binary	A binary stream containing photo data in jpeg format.
toolid	number	reference to the tool.
createdate	date	When the photo was taken
createtime	time	When the photo was taken
tags	collection [number]	An optional collection of tags to attach to this image (tag IDs)
documentid	number	Optional ID of an existing file, to update the file instead of creating a new file
folder	number	Optional ID of a folder, the image should be placed in.
onxnet	boolean	if image is public for extranet.
longitude	float	Optional geolocation longitude of the phone at upload.
latitude	float	Optional geolocation latitude of the phone at upload.
comment	string	Optional comment on the image.
category	number	Optional Reference to existing image's file category.
subcategory	number	Optional Reference to existing image's file subcategory.

Output

document

A document object

AddPhotoToSalesContract

Add a photo file to a specified SalesContract (quotation).

Input

title	string	A file title (not a file name)
imagedata	binary	A binary stream containing photo data in jpeg format.
contractid	number	reference to the tool.
createdate	date	When the photo was taken
createtime	time	When the photo was taken
tags	collection [number]	An optional collection of tags to attach to this image (tag IDs)
documentid	number	Optional ID of an existing file, to update the file instead of creating a new file
folder	number	Optional ID of a folder, the image should be placed in.
onxnet	boolean	if image is public for extranet.
longitude	float	Optional geolocation longitude of the phone at upload.
latitude	float	Optional geolocation latitude of the phone at upload.
comment	string	Optional comment on the image.
category	number	Optional Reference to existing image's file category.
subcategory	number	Optional Reference to existing image's file subcategory.

Output

document

A document object

CreateUpdateFolder

Rename, move a folder, or add a subfolder to an existing folder.

You cannot change the root folder for an object.

Creating

Either parentid or modcode+objectid is required. Title is required. Readaccess and writeaccess permissions are taken from the parent folder.

Renaming

To rename an existing folder you need to specify id and title.

Moving

To move an existing folder you need to specify the ID of the new parent folder. This is done in the field parentid.

Input

title	string	A name for the folder
parentid	number	The Microbizz ID of the parent folder
id	number	The Microbizz ID of an existing folder to update, if any
ispublic	boolean	If folder is public for extranet
modcode	string	The type of object this folder should be long to, eg. "todo" or "customers" etc.
objectid	number	The Microbizz ID of the OD the object this folder shoukld be long

Output

folders

collection [folder]

The folders present on the object

DeleteFolderByID

Delete an existing folder. You cannot delete root folders.

Input

folderid	number	The ID of an existing folder.
withcontent	bool	If this is set to 0 the folder will only be deleted if is doesn't contain any files or subfolders; if set to 1 then the contents will also be deleted

Output

folders

collection [folder]

The folders present on the object

GetImageCategories

Get the image categories and their id's.

Input

None

-

Output

None

-

DeleteDocumentByID

Delete a document/file.

Input

documentid

number

The Microbizz ID of a document/file

Output

None

-

MoveDocumentByModcodeAndID

This will move a given document/file to another object. Notice that the file will be given a new ID.

Input

documentid	number	The ID of a document/file
modcode	string	A string specifying where to the file should be moved, either "todo" or "customers" or "tools"
objectid	number	The ID of the task/customer/equipment to where the file should be moved
filename	string	Optional new name of the file
folder	string	Optional name of folder to store the file in, the folder will be created if it doesn't exist; eg. "Pictures/Cats/"

Output

document

The new document object

Mail

SendMailOnObject

Send a mail to a user or person (or both). Fields from the object will be inserted into the subject+body, refer to the HTML template documentation.

There is a limit to the number of times you may use this call in a given 24h period.

Input

objecttype	string	The type of object this relates to, either "Customer" or "Todo"
objectid	number	The Microbizz ID of the object
mailtemplateid	number	The Microbizz ID of an HTML template
userid	number	The Microbizz ID of a user, either this or personid must be set
personid	number	The MIcrobizz ID of a person, either this or userid must be set
subject	string	If not set then the mail subject will be taken from the HTML template
body	string	If not set then the mail body will be taken from the HTML template

Output

None

-

Anonymization

AnonymizeDataByModcodeAndID

Delete notes, forms mails or activities on a customer, todo or project.

project deletion will additionally delete notes forms and mails which are visible for the project. which also includes connected tasks.

Input

search	string	The search term
modcode	string	should be customers, todo or project.
objectid	number	Id of object defined using modcode
data	string	should be forms, notes, mails or activities.

Output

None or error message

DeleteByModcodeAndID

Delete a project todo or customer

Input

search	string	The search term
modcode	string	should be customers, todo or project.
objectid	number	Id of object defined using modcode

Output

None or error message

CreatePDF

Create a pdf for download.

Either object_id and object_type has to be in use or a file has to be sent. the file needs to be outside the scope of the json, base64 encoded and it needs to be the file of a valid pdf.

Input

object_id	number	The ID of an object, see object_type below
object_type	string	One of “quotation”, “company” or “task”
custom_document	number	The ID of a document in the Data+ module. If this is set the uploaded file will be ignored.
custom_fields	array	There are two parts in the custom_fields. an overwrite of contentarea which this format. { "headerlines":[ { "h":5, "items":[ { "x":20, "w":20, "h":5, "style":{ "fontstyle":"bold", "clip":true }, //propably always text "type":"text", "text":"#" } ] } ], "lines":…, "footerlines": …, "endlines":… } and { "x":142, "y":64.5, "w":50, "h":10, "style":{ "fontsize":9, "font":"helvetica", //used to overwrite the font. "use_default_styling":0 }, "fieldtype":"text", "value":{ "value":"#", "type":"text" } }
custom_areas	array	Describes the height and location of the content area on the page. Only allows one content area so far. Example where the area takes up all of a A4 page: [1 => ["y" => 0, "h" => 297]]

Output

None or error message