...
...
...
...
...
...
...
...
GetTodosByPersonID
Get all todos which have a specific contact person.
Input
...
...
Output
todos | collectiontodo] | A collection of the relevant todos, or an empty collection if no todosNiko was found. |
resumekey | string | Sometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results. |
GetTodoByID
Get a todo by their Microbizz todo id
If no such todo exist an empty collection will be returned.
Input
todoid | number | The microbizz todo id of the todo to fetch |
Output
todos | collectiontodo] | A collection either empty if no todo was found, or with exactly one element being the todo. |
GetTodoByTodoNumber
Get a todo by their todo number.
If no such todo exist an empty collection will be returned.
If several todos exists with the provided todo number, only one of these (unpredicted) is returned.
Input
todonumber | string | The todo number of the customer to fetch |
Output
todos | collection[ todo ] | A collection either empty if no todo was found, or with exactly one element being the todo. |
GetTodoLogByID
Get the log for a todo by the ID and date.
If no such todo exist an empty collection will be returned.
If some todo exist in the log with the provided ID and date, will be returned log data.
Input
todoid | integer | The todo number of the customer to fetch |
date | string | The date |
logtype | string | Which log to read, either db (default) or activity |
Output
result | collection[set] | A list of log lines, the contents of each set depends on the logtype parameter |
Logtype = db
head | string | Log head information. Contains date, time, log level and user ID |
text | string | Log text information |
logname | string | Used log name |
date | string | Log date |
time | string | Log time |
level | string | The level of the log |
uid | integer | User ID |
object | string | Log object data |
Logtype = activity
...
AddPhotoToTodo
Add a photo file to a todo.
Input
todoid | number | The ID of the todo to add the photo to. |
title | string | A file title (not a file name) |
imagedata | binary | A binary stream containing photo data in jpeg format. |
onxnet | boolean | 1 if the file should be visible on the extranet |
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) |
Output
None | - | - |
AddPhotoToCustomer
Add a photo file to a company.
Input
customerid | number | The ID of the customer to add the photo to. |
title | string | A file title (not a file name) |
imagedata | binary | A binary stream containing photo data in jpeg format. |
onxnet | boolean | 1 if the file should be visible on the extranet |
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) |
Output
None | - | - |
AddPhotoToTool
Add a photo file to a tool/equipment.
Input
...
...
Output
...
...
...
...
...
...
...
...
...
None | - | - |
AddFileToCustomer
Add a file to a company/customer.
Input
customerid | number | The ID of the customer to add the file to. |
filename | string | The name of the file, eg. “MyDocument.PDF” |
filedata | binary | A binary stream. |
title | string | A file title (not a file name) |
Output
None | - | - |
AddAudioToTodo
Add an audio file to a todo.
Input
todoid | number | The ID of the todo to add the audio to. |
title | string | A file title (not a file name) |
format | string | One of: mp3 wav aac |
audiodata | binary | A binary stream containing audio data in the specified format. |
Output
None. | - | - |
GetTodoTemplates
Get a list of all todo templates.
Input
None. | - | - |
Output
templates | collection [ todotemplate ] | The available templates |
GetTodoStates
Get a list of all todo states.
Input
None. | - | - |
Output
states | collection [ todostate ] | The available states |
CreateTodoFromTemplate
Create a todo based on a given template.
If a toolid
is provided then the tool will be attached to the todo.
Input
templateid | number | The id of the template (which can be obtained by GetTodoTemplates) |
title | string | A base title for the created todo |
customerid | number | An id of a customer on which to attach the todo. (In some configurations this is required) |
toolid | number | The ID of a tool to attach to the todo |
Output
todo | todo | The primary todo created from the template. (A template can contain more than one todo) |
GetPlannedTodos
Get list of tasks that are planned for the current user.
Input
None | - | - |
Output
todos | collection[number] | List of IDs of the tasks that are planned for the user. |
GetDocumentsByTodoID
Get all documents on a todo by todo id
Input
todoid | number | The Microbizz todo ID |
inclthumbs | bool | True to include thumbnails |
inclfolders | bool | True to include folders |
Output
documents | collection [ document ] | The documents present on the todo |
folders | collection [ folder ] | The folders present on the todo |
GetProductUseByLastChange
Get a collection of all product use since the given date.
Input
...
GetProductUseByTodoID
Get a collection of all product use on the given todo.
Input
...
...
...
...
...
...
...
GetProductUseByToolID
Get a collection of all product use on the given tool.
Input
...
...
Output
productuse | collection[ todoitem ] | A collection of the relevant product use, or an empty collection if no products were used with this tool. |
DeleteProductUseByID
Delete some product use by product use ID. The command will succeed even if the product use doesn't exist.
Input
productuseid | number | ID of the product use to remove |
Output
None | - | - |
AddProductUse
Deprecated: Consider using CreateUpdateProductUse
Add product use to the todo specified by the given todo ID.
Input
...
...
...
...
...
...
...
PlanTodo
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Product and invoicing commands
CreateUpdateProductByID
Creates or updates a product in Microbizz.
If a product with the given product id already exists, then the product will be overwritten.
If the product provided have a product id of 0, a new product will be created and a new product id will be provided.
Input
product | product | The product to create/update |
Output
product | product | The product object as it is in Microbizz after the update |
CreateUpdateProductByProductNumber
Creates or updates a product in Microbizz.
If a product with the given product number already exists, then the product will be overwritten.
If several products exists with the given product number, only one of these (unpredicted) will be overwritten.
If a product number isn't provided in the product object, the command will fail.
The product id in the input product object will be ignored.
Input
product | product | The product to create/update |
Output
product | product | The product object as it is in Microbizz after the update |
AssignIndividualPriceByProductNumber
Assigns an individual price to a given product identified by product number, to a given customer identified by a customer id.
If several products exists with the given product number, only one of these (unpredicted) will be assigned the individual price.
If the product or the customer doesn't exists, the command will still succeed, but nothing will happen.
Input
productnumber | string | Product number |
customerid | number | Id of the customer for which to assign the price |
price | number | Individual price pr. unit in lowest local currency. (Typical danish ører) |
Output
None | - | - |
RemoveIndividualPriceByProductNumber
Removes an individual price to a given product identified by product number, from a given customer identified by a customer id.
If neither the product, the customer nor the individual price exists, the command will still succeed, but nothing will happen.
Input
productnumber | string | Product number |
customerid | number | Id of the customer for which to remove any individual price. If this is omitted, then individual pricing will be removed for all customers. |
Output
None | - | - |
GetProductByID
Get a product by their Microbizz product id
If no such product exist an empty collection will be returned.
Input
productid | number | The Microbizz product id of the product to fetch |
include_prices | boolean | Get prices even if these are disabled |
Output
products | collection[ product ] | A collection either empty if no products was found, or with exactly one element being the product. |
AddInvoiceLine
Adds a new invoice line in Microbizz.
Input
invoiceline | invoiceline | The invoice line to add. The id of the invoice line object will be ignored |
Output
None. | - | - |
GetPendingInvoiceLines
Get all pending invoice lines in Microbizz.
Input
None. | - | - |
Output
invoicelines | collection[ invoiceline ] | All pending invoice lines in Microbizz |
GetInvoiceLinesByLastChange
Get all invoice lines changed after a certain date.
Input
changedate | date | Return all invoice lines changed on or after the provided date. |
changetime | time | If this is provided only return invoice lines changed after the provided date and time. |
resumekey | string | If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries. |
Output
invoicelines | collection [ invoiceline ] | The invoice lines |
MarkInvoiceLinesAsProcessed
Mark the invoice lines with the provided invoice line id's as processed in the Microbizz system, and attach an optional order number for information about which order they were attached to.
Input
invoicelineids | collection[number] | The invoice line ids of the lines that were processed. |
ordernumber | string | Optional order number to indicate on which order the lines were attached. |
Output
None. | - | - |
GetProductByProductNumber
Get a product by their product number.
If no such product exist an empty collection will be returned.
If several products exists with the provided product number, only one of these (unpredicted) is returned.
Input
productnumber | string | The product number of the product to fetch |
include_prices | boolean | Get prices even if these are disabled |
Output
products | collection[ product ] | A collection either empty if no products was found, or with exactly one element being the product. |
GetProductsByLastChange
Get a collection of products changed since a given date and time.
Input
changedate | date | Return all products changed on or after the provided date. |
changetime | time | If this is provided only return products changed after the provided date and time. |
resumekey | string | If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries |
include_prices | boolean | Get prices even if these are disabled |
ignoreclosed | boolean | Skip products that are deleted |
onlyfavorites | boolean | If 1 then only get products that are the favorites of the current user |
Output
products | collection[ product ] | A collection of the relevant products, or an empty collection if no products were found. |
resumekey | string | Sometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results. |
DeleteProductByID
Deletes a product by their Microbizz product id
The product is only deleted from the product catalog. Instances of the product used in offers and on customers are retained.
Input
productid | number | The Microbizz product id of the product to delete |
Output
None. | - | - |
CreateDirectOrder
Create a direct order / quotation.
Input
customerid | number | The ID of the customer in Microbizz |
lines | collection[directorderline] | The order lines |
note | string | A note to use for the quotation |
deliverydate | date | Delivery date for the quotation |
There must be at least 1 order line.
Output
...