Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

productscollection[ 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

invoicelineinvoicelineThe 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

invoicelinescollection[ invoiceline ]All pending invoice lines in Microbizz

GetInvoiceLinesByLastChange

Get all invoice lines changed after a certain date.

Input

changedatedateReturn all invoice lines changed on or after the provided date.
changetimetimeIf this is provided only return invoice lines changed after the provided date and time.
resumekeystringIf a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries.

Output

invoicelinescollection [ 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

invoicelineidscollection[number]The invoice line ids of the lines that were processed.
ordernumberstringOptional order number to indicate on which order the lines were attached.

Output

None.--

GetProductByProductNumber

...

If several products exists with the provided product number, only one of these (unpredicted) is returned.

Input


productnumberstringThe product number of the product to fetch
include_pricesbooleanGet prices even if these are disabled

Output


productscollection[ product ]A collection either empty if no products was found, or with exactly one element being the product.

...

Get a collection of products changed since a given date and time.

Input


changedatedateReturn all products changed on or after the provided date.
changetimetimeIf this is provided only return products changed after the provided date and time.
resumekeystringIf a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries
include_pricesbooleanGet prices even if these are disabled
ignoreclosedbooleanSkip products that are deleted
onlyfavoritesbooleanIf 1 then only get products that are the favorites of the current user

Output


productscollection[ product ]A collection of the relevant products, or an empty collection if no products were found.
resumekeystringSometimes 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.

...

The product is only deleted from the product catalog. Instances of the product used in offers and on customers are retained.

Input


productidnumberThe Microbizz product id of the product to delete

Output


None.--

CreateDirectOrder

Create a direct order / quotation.

Input


customeridnumberThe ID of the customer in Microbizz
linescollection[directorderline]The order lines
notestringA note to use for the quotation
deliverydatedateDelivery date for the quotation

There must be at least 1 order line.

Output


None--