Skip to main content
Skip table of contents

Invoice commands

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.--

CreateUpdateInvoice

Create or update a new invoice by its ID.

If an invoice with the given id already exists, then the invoice will be overwritten.

If the invoice provided has an id of 0, a new invoice will be created.

Input

invoiceinvoiceThe invoice to create or update.

Output

invoiceinvoiceThe invoice as it was added.

CreateUpdateInvoiceLineByID

Create or update a new invoice line by its ID.

If an invoice line with the given id already exists, then the invoice line will be overwritten.

If the invoice line provided has an id of 0, a new invoice line will be created.

Input

invoicelineinvoicelineThe invoice line to create or update.

Output

invoicelineinvoicelineThe invoice line as it was added.

DeleteInvoiceLineByID

Deletes an invoice line from Microbizz.

Input

invoicelineidnumberThe ID of the invoice line to delete.

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

GetInvoiceLinesByInvoiceID

Get all invoice lines for an invoice.

Input

invoiceidnumberThe Microbizz ID of an invoice

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.--

GetWorkareaBasePrices

Read the hourly/cost prices for the workareas. If a user doesn't have a price for a workarea, then the price for the customer should be used; if the customer doesn't have a price for the workarea, then the customer type price should be used; if the customer type doesn't have a price, then the base price should be used.

Input

None.--

Output

pricescollection[waprice]A list of the base prices for the workareas
timeconversionscollection[set]A list of sets that describe the time conversion, each set holds id and title
discountboolIf the new discount functionality has been enabled

A waprice set holds some of the following:

workareaidnumberThe Microbizz ID of a workarea
itemnumberstringA product number 
hourpricenumberPrice per hour in lowest local currency (typically Danish ører). This price is before any discount.
costpricenumberCost price in lowest local currency (typically Danish ører). This price is before any discount.
discountnumberA discount in %
timeconversionnumberHow minutes are rounded, see the timeconversions field
usestdpriceboolIf this workarea doesn't have a individual price


GetWorkareaCustomerTypePrices

Input

None.--

Output

pricescollection[ctprice]A list of the base prices for the workareas
timeconversionscollection[set]A list of sets that describe the time conversion, each set holds id and title
discountboolIf the new discount functionality has been enabled

A ctprice set holds the following:

customertypeidnumberThe MIcrobizz ID of a customer type
titlestringThe name of the customer type
pricescollection[waprice]A list of the customer type prices for the each of the workareas


GetWorkareaCustomerPricesByCustomerID

Input

customeridnumberThe Microbizz ID of a customer

Output

pricescollection[waprice]A list of the customer prices for the workareas
timeconversionscollection[set]A list of sets that describe the time conversion, each set holds id and title
discountboolIf the new discount functionality has been enabled

GetWorkareaUserPricesByUserID

This returns the individual price that are setup for the given user. It only returns prices for the workareas that the given user can access.

Input

useridnumberThe Microbizz ID of a user

Output

pricescollection[waprice]A list of the user prices for the workareas
timeconversionscollection[set]A list of sets that describe the time conversion, each set holds id and title
discountboolIf the new discount functionality has been enabled

GetCustomerIndividualPricesByCustomerID

Input

customeridnumberThe MIcrobizz ID of a company

Output

pricescollection[indiprice]A list of product numbers and the individuel prices for these products for this company

The indiprice set holds the following:

itemnumberstringThe product number
productnamestringThe name of the product
individualnumberstringOptional alternative product number to use instead of the actual product number; don't use if empty
individualnamestringOptional alternative product name to use use; don't use if empty
pricenumber

Price in lowest local currency (typically Danish ører). This price is before any discount.

costpricenumberThe costprice of the product,  in lowest local currency (typically Danish ører). This price is before any discount.

GetInvoiceByID

Get an invoice by its Microbizz invoice id

If no such invoice exist an empty collection will be returned.

Input

invoiceidnumberThe Microbizz ID of an invoice

Output

invoicesinvoices[invoice]A collection either empty if no invoices was found, or with exactly one element being the invoice.

GetInvoicesByLastChange

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

Input

changedatedateReturn all invoices changed on or after the provided date.
changetimetimeIf this is provided only return invoices 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

invoicescollection[invoice]A collection of the relevant invoices, or an empty collection if no invoices was 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.

GetEDIByID

Get an EDI by its Microbizz EDI id

If no such EDI exist an empty collection will be returned.

Input

ediidnumberThe Microbizz ID of an EDI

Output

edisedis[edi]A collection either empty if no EDI was found, or with exactly one element being the EDI.

GetEDIsByLastChange

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

Input

changedatedateReturn all EDIs changed on or after the provided date.
changetimetimeIf this is provided only return EDIs 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

ediscollection[edi]A collection of the relevant EDIs, or an empty collection if no EDIs was 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.

GetEDILineByID

Get an EDI line by its Microbizz  id

If no such EDI line exist an empty collection will be returned.

Input

edilineidnumberThe Microbizz ID of an EDI line

Output

edilinesedilines[ediline]A collection either empty if no EDI line was found, or with exactly one element being the EDI line.

CreateUpdateEDI

Update an EDI by its Microbizz EDI id. You cannot create a new EDI.


Input

ediediAn EDI, notice that only a few fields may be updated, see below

Output

ediediThe updated EDI.

The following fields may be updated: phase, customerid, userid, note, externalid, taxamount, sellersorderid.

phase can be set to either 1 (pending), 2 (assigned) or 100 (approval).

GetEDILinesByLastChange

Get a collection of EDI lines changed since a given date and time.

Input

changedatedateReturn all EDI lines changed on or after the provided date.
changetimetimeIf this is provided only return EDI 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

edilinescollection[ediline]A collection of the relevant EDI lines, or an empty collection if no EDI lines was 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.

GetEDILinesByEDIID

Get the EDI lines that belong to an EDI .

Input

ediidnumberThe Microbizz ID of an EDI 

Output

edilinescollection[ediline]A collection of the relevant EDI lines, or an empty collection if no EDI lines was found.



JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.