Sales commands | Micropedia

RegisterCall

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

Input

phonenumber	string	The phone number called or called from
incoming	boolean	If true, then this is treated as an incoming call, otherwise an outgoing call.
calldate	date	The date of the call
calltime	time	The time of the call
duration	number	The duration of the call in minutes.

Output

none

GetMyPendingCalls

Get all pending calls of the current user

Input

None

Output

calls

collection[call]

A collection of pending calls or an empty collection.

EndCall

Ends a call in Microbizz.

Input

callid	number	Call ID of the call to end
duration	number	Duration of the call in minutes.
answer	answer	If a question form was requested on call end, the answer can be provided here.
note	string	An optional note to attach to the call. (A summary of the call)

Output

none

CreateCall

Creates a new call in Microbizz.

Input

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

Output

call

The 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

units

collection[ productunit ]

The product units

CreateUpdateProductUnit

Update product unit, or create new product unit.

Input

unit

productunit

The product unit

Output

unit

productunit

The product unit

GetSalesContractsByLastChange

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

Input

changedate	date	-
changetime	time
use_pagination	bool	If 0 you will get all changes contracts, if 1 you will get a limited number of contracts and will have to use the resumekey to get the rest
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

salescontracts

collection[salescontract]

GetSalesContractLinesByLastChange

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

Input

changedate	date	-
changetime	time

Output

lines

collection[salescontractline]

CreateUpdateSalesContract

Create a new quotation, or update an existing quotation.

Input

salescontract

Output

salescontract

The new or updated quotation

CreateUpdateSalesContractLine

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

Input

line

salescontractline

Output

line

salescontractline

The new or updated line

AddFavoriteProduct

Add a product number to the list of favorite products.

Input

productnumber

string

A product number

Output

product

The affected product

RemoveFavoriteProduct

Remove a product number from the list of favorite products.

Input

productnumber

string

A product number

Output

product

The affected product

SetFavoriteProducts

Set the list of favorite products.

Input

favorites

collection[string]

A list of product numbers

Output

None

GetFavoriteProducts

Get the list of favorite products.

Input

None

Output

favorites

collection[string]

A list of product numbers

AddFileToSalesContract

Add a file to a salescontract (quotation).

Input

contractid	number	The ID of the salescontract to add the file to.
filename	string	The name of the file, eg. “MyDocument.PDF”
filedata	binary	A binary stream. base64_encode(Required)
title	string	A file title (not a file name)
folder	string	The path of the folder, eg. "FilesFromAPI/Diagrams"

Output

None

GetInvoicePricingBySource

Get the list of prices.

Input

source	string	basic, customertype or customer.
id	number	0 if basic. otherwise the id of the type.

Output

ips

collection[prices]

Format { itemnumber, hourprice, costprice, discount, timeconversion, workareaid }

CreateUpdateInvoicePricing

Update a list of prices.

Input

source	string	basic, customertype, customer or user.
id	number	0 if basic. otherwise the id of the type.
ips	array	Format in array { itemnumber, hourprice, costprice, discount, timeconversion, workareaid }

Output

ips

collection[prices]

Format { itemnumber, hourprice, costprice, discount, timeconversion, workareaid }