Versions Compared

Key

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

RegisterCall

Registers a raw call in the Microbizz system. A raw call is a call which didn't originate from Microbizz

Input

phonenumberstringThe phone number called or called from
incomingbooleanIf true, then this is treated as an incoming call, otherwise an outgoing call.
calldatedateThe date of the call
calltimetimeThe time of the call
durationnumberThe duration of the call in minutes.

Output

none--

GetMyPendingCalls

Get all pending calls of the current user

Input

None--

Output

callscollection[call]A collection of pending calls or an empty collection.

EndCall

Ends a call in Microbizz.

Input

callidnumberCall ID of the call to end
durationnumberDuration of the call in minutes.
answeranswerIf a question form was requested on call end, the answer can be provided here.
notestringAn optional note to attach to the call. (A summary of the call)

Output

none--

CreateCall

Creates a new call in Microbizz.

Input

callcallEven though the ID field must be provided it is ignored.
useridnumberA user ID indicating whom expected to make the call. If this is left out, the current user is assumed.

Output

callcallThe call as created

GetMAEvents

Get all MA events in Microbizz.

Input

None--

Output

events[maevent]The marketing events

GetProductStates

Get all product use statuses and budget areas.

Input

None--

Output

states[ productusestate ]The product use states
budgetareas[ budgetarea ]The budget areas

GetProductUnits

Get all product units.

Input

None--

Output

unitscollection[ productunit ]The product units

CreateUpdateProductUnit

Update product unit, or create new product unit.

Input

unitproductunitThe product unit

Output

unitproductunitThe product unit

GetSalesContractsByLastChange

Get all contracts / quotations that have changed since a given date.

Input

changedatedate-
changetimetime

Output

salescontractscollection[salescontract]

GetSalesContractLinesByLastChange

Get all contract/quotation lines that have changed since a given date.

Input

changedatedate-
changetimetime

Output

linescollection[salescontractline]

CreateUpdateSalesContract

Create a new quotation, or update an existing quotation.

Input

salescontractsalescontract

Output

salescontractsalescontractThe new or updated quotation

CreateUpdateSalesContractLine

Create a line for a quotation, or update an existing line.

Input

Output

linesalescontractlineThe new or updated line

AddFavoriteProduct

Add a product number to the list of favorite products.

Input

productnumberstringA product number

Output

productproductThe affected product

RemoveFavoriteProduct

Remove a product number from the list of favorite products.

Input

productnumberstringA product number

Output

productproductThe affected product

SetFavoriteProducts

Set the list of favorite products.

Input

favoritescollection[string]A list of product numbers

Output

None--

GetFavoriteProducts

Get the list of favorite products.

Input

None--

Output

favoritescollection[string]A list of product numbers


AddFileToSalesContract

Add a file to a salescontract (quotation).

Input


contractidnumberThe ID of the salescontract to add the file to.
filenamestringThe name of the file, eg. “MyDocument.PDF”
filedatabinaryA binary stream. base64_encode(Required)
titlestringA file title (not a file name)
folderstringThe path of the folder, eg. "FilesFromAPI/Diagrams"


Output


None--