Invoice commands

AddInvoiceLine

Adds a new invoice line in Microbizz.

Input

invoiceline

The 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

invoice

The invoice to create or update.

Output

invoice

The 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

invoiceline

The invoice line to create or update.

Output

invoiceline

The invoice line as it was added.

DeleteInvoiceLineByID

Deletes an invoice line from Microbizz.

Input

invoicelineid

number

The ID of the invoice line to delete.

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

GetInvoiceLinesByInvoiceID

Get all invoice lines for an invoice.

Input

invoiceid

number

The Microbizz ID of an invoice

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.

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

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

A waprice set holds some of the following:

workareaid	number	The Microbizz ID of a workarea
itemnumber	string	A product number
hourprice	number	Price per hour in lowest local currency (typically Danish ører). This price is before any discount.
costprice	number	Cost price in lowest local currency (typically Danish ører). This price is before any discount.
discount	number	A discount in %
timeconversion	number	How minutes are rounded, see the timeconversions field
usestdprice	bool	If this workarea doesn't have a individual price

GetWorkareaCustomerTypePrices

Input

None.

Output

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

A ctprice set holds the following:

customertypeid	number	The MIcrobizz ID of a customer type
title	string	The name of the customer type
prices	collection[waprice]	A list of the customer type prices for the each of the workareas

GetWorkareaCustomerPricesByCustomerID

Input

customerid

number

The Microbizz ID of a customer

Output

prices	collection[waprice]	A list of the customer prices for the workareas
timeconversions	collection[set]	A list of sets that describe the time conversion, each set holds id and title
discount	bool	If 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

userid

number

The Microbizz ID of a user

Output

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

GetCustomerIndividualPricesByCustomerID

Input

customerid

number

The MIcrobizz ID of a company

Output

prices

collection[indiprice]

A list of product numbers and the individuel prices for these products for this company

The indiprice set holds the following:

itemnumber	string	The product number
productname	string	The name of the product
individualnumber	string	Optional alternative product number to use instead of the actual product number; don't use if empty
individualname	string	Optional alternative product name to use use; don't use if empty
price	number	Price in lowest local currency (typically Danish ører). This price is before any discount.
costprice	number	The 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

invoiceid

number

The Microbizz ID of an invoice

Output

invoices

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

changedate	date	Return all invoices changed on or after the provided date.
changetime	time	If this is provided only return invoices 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

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

GetEDIByID

Get an EDI by its Microbizz EDI id

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

Input

ediid

number

The Microbizz ID of an EDI

Output

edis

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

changedate	date	Return all EDIs changed on or after the provided date.
changetime	time	If this is provided only return EDIs 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

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

GetEDILineByID

Get an EDI line by its Microbizz id

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

Input

edilineid

number

The Microbizz ID of an EDI line

Output

edilines

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

edi

edi

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

Output

edi

The 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

changedate	date	Return all EDI lines changed on or after the provided date.
changetime	time	If this is provided only return EDI 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

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

GetEDILinesByEDIID

Get the EDI lines that belong to an EDI .

Input

ediid

number

The Microbizz ID of an EDI

Output

edilines

collection[ediline]

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