...
...
...
...
...
...
...
Output
| None | - | - |
AddPhotoToTool
Add a photo file to a tool/equipment.
Input
...
Output
| None | - | - |
AddFileToTodo
Add a file to a task.
Input
...
Output
| None | - | - |
AddAudioToTodo
Add an audio file to a todo.
Input
...
...
Output
...
GetTodoByID
Get a todo by their Microbizz todo id
If no such todo exist an empty collection will be returned.
Input
...
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
...
GetTodosByPersonID
Get all todos which have a specific contact person.
Input
| personid | number | The Microbizz ID of the contact person |
Output
...
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
...
...
...
...
...
| None. | - | - |
GetTodoTemplates
Get a list of all todo templates.
Input
| None. | - | - |
Output
...
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
...
...
...
Output
| todo | todo | The primary todo created from the template. (A template can contain more than one todo) |
GetPlannedTodos
...
...
...
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
| 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.
Input
| todoid | number | ID of todo to receive product use |
Output
...
GetProductUseByToolID
Get a collection of all product use on the given tool.
Input
| 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.
Input
...
Output
| None | - | - |
AddProductUse
Deprecated: Consider using CreateUpdateProductUse
Add product use to the todo specified by the given todo ID.
Input
...
...
...
...
Output
| None | - | - |
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.
Input
...
Output
| None | - | - |
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.
Input
...
...
GetProductUsePendingInvoicing
Get all product use pending invoicing.
...
...
Output
| productuse | collection[ todoitem ] | A collection of all product use pending invoicing. |
MarkProductUseAsInvoiced
...
...
...
Output
| None | - | - |
GetPlanDestinations
Get all destinations for use when planning a todo
...
...
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
...
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.
Input
...
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.
Input
...
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.
Input
...
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 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. |
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
...