CreateUpdateTodo
Creates or updates a todo in Microbizz.
If a todo with the given todo id already exists, then the todo will be overwritten.
If the todo provided has a todo id of 0, a new todo will be created and a new todo id will be provided.
If a toolid is provided then the tool will be attached to the todo.
| todo | todo | The todo to create/update |
| toolid | number | The ID of a tool to attach to the todo |
Output
| todo | todo | The todo object as it is in Microbizz after the update |
CreateUpdateTodoByTodoNumber
Creates or updates a todo in Microbizz. The todo is identified by the number field in the todo.
If a todo with the given todo number already exists, then the todo will be overwritten, otherwise a new todo will be created and assigned the supplied todo number. Currently no test is made as to the validity of the todo number.
If a toolid is provided then the tool will be attached to the todo.
| todo | todo | The todo to create/update |
| toolid | number | The ID of a tool to attach to the todo |
Output
| todo | todo | The todo object as it is in Microbizz after the update |
CloseTodoByID
Closes a todo by todo ID
The todo is only closed if close conditions are fullfilled. The command will not fail, if the todo isn't closed, but the returned object will reflect that the todo is still open
| todoid | number | The ID of the todo which should be closed |
| stateid | number | The state to which this todo should be closed to. (Obtained by GetTodoStates). Only close states is allowed here. |
| answer | answer | If a question form is requested on todo close, then the answers can be provided here. |
| note | note | A note, will be tagged with 'Solution' |
Output
| todo | todo | The todo object as it is in Microbizz after the update |
GetTodosByLastChange
Get a collection of todos changed since a given date and time.
| changedate | date | Return all tod's changed on or after the provided date. |
| changetime | time | If this is provided only return todo's 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 |
| ignoreclosed | bool | If 1 then don't send todo's that current user do not have access to |
| limitnumobjects | bool | If 1 then Microbizz will only send todo's that it thinks are particularly relevant for the user |
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.
| 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.
| 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.
| 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
| userid | number | The Microbizz ID of the user who genereated this log line |
| customerid | number | The MB ID of a customer which may be relevant |
| unitid | number | The MB ID of a unit which may be relevant |
| projectid | number | The MB ID of a project which may be relevant |
| modcode | string | A code for which module generated this log line |
| date | date | When the log line was generated |
| time | time |
|
| text | string | The log line, may be HTML |
| link | string | An optional link to some page in MB which is relevant |
GetTodosByPersonID
Get all todos which have a specific contact person.
| personid | number | The Microbizz ID of the contact person |
Output
AddPhotoToTodo
Add a photo file to a todo.
| 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
AddPhotoToCustomer
Add a photo file to a company.
| 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
Add a photo file to a tool/equipment.
| toolid | number | The ID of the tool 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
AddFileToTodo
Add a file to a task.
| todoid | number | The ID of the task 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) |
| folder | string | The path of the folder, eg. "FilesFromAPI/Diagrams" |
Output
AddAudioToTodo
Add an audio file to a todo.
| 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
GetTodoTemplates
Get a list of all todo templates.
Output
GetTodoStates
Get a list of all todo states.
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.
| 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.
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
| 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.
| changedate | date | Return all product use on or after the provided date. |
| changetime | time | If this is provided only return product use 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
| productuse | collection[ todoitem ] | A collection of the relevant product use, or an empty collection if no products were used. |
| 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. |
GetProductUseByTodoID
Get a collection of all product use on the given todo.
| todoid | number | ID of todo to receive product use |
Output
| productuse | collection[ todoitem ] | A collection of the relevant product use, or an empty collection if no products were used on this todo. |
Get a collection of all product use on the given tool.
| toolid | number | ID of tool to receive product use |
| spareparts | boolean | 1 to get spareparts only, 0 to get non-spareparts only |
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.
| productuseid | number | ID of the product use to remove |
Output
AddProductUse
Deprecated: Consider using CreateUpdateProductUse
Add product use to the todo specified by the given todo ID.
| productuse | todoitem | The product use. Even though the id field must be provided, it is ignored. |
| todoid | number | ID of todo to receive product use |
| nopricecalc | boolean | Set to 1 to disable price calculation (eg. when copying product use) |
| copyid | number | Optional ID of the prod.use that was copied, used for copying some details |
Output
AddPartsList
Add product use to the todo specified by the given todo ID. Most of the details will be taken from the parts list setup.
| productuse | collection[ partuse ] | Details about the product used for each part in the parts list. |
| todoid | number | ID of todo to receive product use |
| useddate | date | The date of use |
| usedtime | time | The time of use |
Output
CreateUpdateProductUse
Creates or updates some product use in Microbizz.
If some product use with the given productuse id already exists, then the product use will be overwritten.
If the product use provided have a productuse id of 0, new product use will be created and a new productuse id will be provided.
| productuse | todoitem | The product use to create/update |
| nopricecalc | boolean | Set to 1 to disable price calculation (eg. when copying product use) |
| copyid | number | Optional ID of the prod.use that was copied, used for copying some details |
Output
| productuse | todoitem | The product use object as it is in Microbizz after the update |
GetProductUsePendingInvoicing
Get all product use pending invoicing.
Output
| productuse | collection[ todoitem ] | A collection of all product use pending invoicing. |
MarkProductUseAsInvoiced
Mark the selected product use as invoiced.
| productuseids | collection[number] | A collection of all product use ids to mark as invoiced. |
Output
GetPlanDestinations
Get all destinations for use when planning a todo
Output
| destinations | collection[ plandestination ] | A collection of all destinations which can be used. |
| myself | number | The destination that is the user himself |
PlanTodo
Plan a todo to a specific destination.
| todoid | number | ID of the todo to plan. |
| date | date | Date to plan to. |
| time | time | Time to plan to. |
| destination | string | The destination to plan to, see GetPlanDestinations ; may be an array of string, to plan to multiple users/teams. |
| duration | number | Number of minutes to plan; must be 0 if enddate is set. |
| enddate | date | If set then there will be planned for all the dates between 'date' and 'enddate'. |
| endtime | time | Only used if enddate is set, in which case it is required. |
| nonworkingdays | bool | If true then also plan on non-working days. |
| fullday | boolean | 1 to create full day planning or 0 to create normal planning; duration+enddate+endtime+time are ignored for full day plannings |
Output
| prodplanids | collection[number] | The Microbizz IDs of all the plannings that were created |
destination consist of a letter (either u for user or t for team) followed by a number (the ID of the user/team). Eg. u29 or t3. When planning to a team, the team of the todo will be changed to the specified team, and the planning will be made anonymous.
GetWorkpoolsByLastChange
Get info about the workpools.
| changedate | date |
|
| changetime | time |
|
Output
| disabled | bool | If workpools are disabled, default is false |
| workpools | collection[ workpool ] | A collection of workpools |
Each set in workpools contains information about a workpool. The API call will always return all the workpools, but the content (list of tasks) of a workpool will only be included in if the workpool or its contents has changed since changedate.
AddRemoveWorkpoolEntry
Add a Todo to a workpool, or remove a Todo from a workpool.
| workpoolentryid | number | ID of a workpool entry in Microbizz |
| todoid | number | ID of a Todo in Microbizz |
| workpoolid | number | ID of a workpool in Microbizz |
Output
| wastaken | bool | True if the Todo was removed from the workpool |
| workpoolentry | workpoolentry | Only if the Todo was added to a workpool |
If workpoolentryid is specified, then the Todo will be removed from the pool, and the responsible user will be set to the current user.
If workpoolentryid isn't specified, but workpoolid and todoid both are, then the Todo will be added to the workpool.
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.
| 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.
| 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.
| 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
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.
| 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
GetProductByID
Get a product by their Microbizz product id
If no such product exist an empty collection will be returned.
| 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.
| invoiceline | invoiceline | The invoice line to add. The id of the invoice line object will be ignored |
Output
GetPendingInvoiceLines
Get all pending invoice lines in Microbizz.
Output
| invoicelines | collection[ invoiceline ] | All pending invoice lines in Microbizz |
GetInvoiceLinesByLastChange
Get all invoice lines changed after a certain date.
| 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.
| 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
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.
| 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.
| 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.
| productid | number | The Microbizz product id of the product to delete |
Output
CreateDirectOrder
Create a direct order / quotation.
| 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
