/
Customer commands

Customer commands

Feb 20, 2024

CreateUpdateCustomerByID

Creates or updates a company/customer in Microbizz.

If a company with the given company id already exists, then the company will be overwritten.

If the company provided have a company id of 0, a new company will be created and a new company id will be provided.

Input

customer

customer

The company/customer to create/update

Output

customer

customer

The company/customer object as it is in Microbizz after the update

CreateUpdateCustomerByCustomerNumber

Creates or updates a company/customer in Microbizz.

If a company with the given customer number already exists, then the company will be overwritten.

If several companies exists with the given customer number, only one of these (unpredicted) will be overwritten.

If a customer number isn't provided in the customer object, the command will fail.

The company id in the input customer object will be ignored.

Input

customer

customer

The company/customer to create/update

Output

customer

customer

The company/customer object as it is in Microbizz after the update

GetCustomerByID

Get a customer by their Microbizz customer id

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

Input

customerid

number

The microbizz customer id of the customer to fetch

Output

customers

collection[ customer ]

A collection either empty if no customer was found, or with exactly one element being the customer.

GetCustomersByParentID

Get the customers that have another customer as "parent".

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

Input

customerid

number

The microbizz customer id of the customer to fetch

ignoreclosed

boolean

Don't include customers that are closed/deleted

includeall

boolean

Set to 1 to also include customers that are grandchildren (or grand-grandchildren etc) of the customer

Output

customers

collection[ customer ]

A collection either empty if no customer was found or with the found customers

GetCustomerByCustomerNumber

Get a customer by their customer number.

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

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

Input

customernumber

string

The customer number of the customer to fetch

Output

customers

collection[ customer ]

A collection either empty if no customer was found, or with exactly one element being the customer.

GetCustomerByName

Get a customer by its name.

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

If several customers exists with the provided name, only one of these (unpredicted) is returned.

Uppercase/lowercase is ignored, so searching for "VENTU" may find "Ventu".

Input

customername

string

The name of the customer to fetch

Output

customers

collection[ customer ]

A collection either empty if no customer was found, or with exactly one element being the customer.

GetCustomersByLastChange

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

Input

changedate

date

Return all customers changed on or after the provided date.

changetime

time

If this is provided only return customers 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

ignoreclosed

bool

If 1 then don't sent customers that current user do not have access to

skip_deleted

bool

If 1 then don't send deleted customers

Output

customers

collection[ customer ]

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

qfoncheckout

number

The ID of a question form to fill in when checking out from a customer.

GetDepotOrderLinesByLastChange

Get all depot order lines.

Input

changedate

date

Return all depot order lines changed on or after the provided date.

changetime

time

If this is provided only return depot order 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

lines

collection [ depotorderline ]

The depot orderlines

GetDocumentsByCustomerID

Get all documents on a customer by customer id

Input

customerid

number

The Microbizz customer ID

inclthumbs

bool

True to include thumbnails

inclfolders

bool

True to include folders

Output

documents

collection [ document ]

The documents present on the customer

folders

collection [ folder ]

The folders present on the customer

GetCustomerTypes

Get all Microbizz customer types. All customer types are returned, and replaces earlier customer types.

Input

None

-

-

Output

types

collection[ customertype ]

A collection of all customer types in the Microbizz system.

GetProceduresByLastChange

Get all proceduress.

Input

changedate

date

Return all procedures changed on or after the provided date.

changetime

time

If this is provided only return procedures 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.

skip_deleted

bool

If 1 then don't send deleted procedures

Output

procedures

collection[ procedure ]

The procedures



AddFileToCustomer

Add a file to a company/customer.

Input

customerid

number

The ID of the customer 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

-

-

AddPhotoToCustomer

Add a photo file to a company.

Input



customerid

number

The ID of the customer to add the photo to.

title

string

A file title (not a file name)

imagedata

binary

A binary stream containing photo data in jpeg format.

onxnet

boolean

1 if the file should be visible on the extranet

createdate

date

When the photo was taken

createtime

time

When the photo was taken

tags

collection [number]

An optional collection of tags to attach to this image (tag IDs)

documentid

number

Optional ID of an existing file, to update the file instead of creating a new file

Output



document

document

A document object

GetMaingroups

Get all maingroups.

Input

None

-

-

Output

maingroups

collection[ maingroup ]

The maingroups, each maingroup contains two fields "id" and "title"

GetCustomerRoles

Gets a list of the customer roles.

Input

Output

customer_roles

collection[ CustomerRole]

A collection of customer roles.



GetParentCustomers

Get a all parent customers for a customer.

If no parent customer exist an empty collection will be returned.

Input

customerid

number

The Microbizz customer ID of the "child" customer

ignoreclosed

bool

If set to 1 then closed/deleted customers will not be included

Output

customers

collection[ customer ]

A collection of customers, the first is the first parent, the send is the second paremt etc.

Subscription

GetSubscriptionsByCustomerID

Get all subscriptions for a company.

Input

customerid

number

The Microbizz ID of a company/customer

Output

subscriptions

collection[ subscription ]

The subscriptions

GetSubscriptionsBylastChangeID

Get subscriptions that have changed since a date.

Input

changedate

date

Return all subscriptions changed on or after the provided date.

changetime

time

If this is provided only return subscriptions changed after the provided date and time.

Output

subscriptions

collection[ subscription ]

The subscriptions

resumekey

string

If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries.