Skip to content
  • There are no suggestions because the search field is empty.

Customer - person relation commands

CreateUpdateRelationByID

Creates or updates a relation in Microbizz.

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

If the relation provided have a relation id of 0, a new relation will be formed.

Input

 
 

relation

cprelationship

The relation to create/update

 
 
 

Output

 
 

relation

cprelationship

The relation object as it is in Microbizz after the update

 
 
 

GetRelationsByLastChange

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

Input

 
 

changedate

date

Return all relations changed on or after the provided date.

changetime

time

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

skip_deleted

bool

If 1 then don't send deleted relations

 
 
 

Output

 
 

relations

collection[ cprelationship ]

A collection of the relevant relations, or an empty collection if no relations were found.

 
 
 

GetRelationsByPersonID

Get a collection of relations that describe how a given person is related to various companies.

Input

 
 

personid

number

The Microbizz ID of a person

 
 
 

Output

 
 

relations

collection[ cprelationship ]

The relations between the person and various companies

 
 
 

GetRelationsByCustomerID

Get a collection of relations that describe how a given company is related to various persons.

Input

 
 

customerid

number

The Microbizz ID of a company

 
 
 

Output

 
 

relations

collection[ cprelationship ]

The relations between the company and various persons

 
 
 

GetAllRelationsByCustomerID

Get a collection of relations that describe how a given company is related to various customers and persons.

Input

 
 

customerid

number

The Microbizz ID of a company

 
 
 

Output

 
 

relations

[ collection[ cprelationship ], collection[ crelationship ]

The relations between the company and various persons and companies

 
 
 

GetRelationTypes

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

Input

 
 

None

-

-

 
 
 

Output

 
 

types

[ collection[ relationtype ] ]

A collection of all customer types in the Microbizz system.