Imprezian360-CRM (Preview)

Imprezian360 CRM All-In-One

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet

Contact
URL	https://www.imprezian360.com/support

Connector Metadata
Publisher	KnowTia Concepts Corporation
Website	https://www.imprezian360.com
Privacy policy	https://www.imprezian360.net/privacy.html

Creating a connection

The connector supports the following authentication types:


Default	Required parameters for creating connection.	All regions

Default

Applicable: All regions

Required parameters for creating connection.

Name	Type	Description
username	securestring	The username for this api
password	securestring	The password for this api

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add New Member	Adds a marketing campaign member
Create New Campaign	Creates a new marketing campaign in the CRM
Create New ComLog	New Communication Entry
Create new CRM Contact	Creates a qualified prospect, customer or vendor
Create New FollowUp	Creates a new followup
Create New Item	All tags are required to be present, even if blank.
Create New Lead	Creates a new sales lead
Create New Order	Creates a new order
Create New Shipment	Creates a shipment
Create New WorkOrder	New Work-Order
Get Active Leads	Returns a list of active sales leads
Get Active Orders	Returns a list of active orders
Get Campaign List	Returns a list of campaigns
Get ComLogs	Returns a list of requested communication ID's
Get Contact List	retrieves a list of contacts
Get FollowUp List	Retrieve list of followups
Get Item List	Returns a list of all items
Get Member List	Marketing campaign members
Get Shipment List	Returns a list of shipments
Get WorkOrder List	List of workorders
Remove Campaign Member	Removes a marketing campaign member
Retrieve Campaign Details	Retrieves the details of a specific campaign request by id
Retrieve ComLog Details	Returns field details
Retrieve CRM Contact Details	Retrieves details about the specified contact
Retrieve followup Details	Followup details
Retrieve Item Details	Details about a specific item
Retrieve Lead Details	retrieves the lead details
Retrieve Member Details	retrieve details about a member
Retrieve Order Details	Retrieve details of an order
Retrieve Shipment Details	get shipment details
Retrieve WorkOrder Details	Returns details of a WO
Update Campaign Data	Updates a marketing campaign in the CRM
Update Comlog Data	Updates a communication entry
Update CRM Contact Data	`Update the specified CRM contact`
Update followup Data	Updates a followup
Update Item Data	Updates an existing item
Update Lead Data	Update an existing sales lead
Update Order Data	Updates an existing order
Update Shipment Data	Updates an existing shipment
Update WorkOrder Data	Updates an existing WO

Add New Member

Operation ID:: Members_PostValue

Adds a marketing campaign member

Parameters

Name	Key	Type	Description
Campaign ID	promoid	string	The ID of the campaign to link to
Record Type	recordtype	string	L for Lead, C for Contact
Contact ID	recordid	string	Contact ID or Lead ID tied to campaign

Returns

response: object

Create New Campaign

Operation ID:: Campaign_PostValue

Creates a new marketing campaign in the CRM

Parameters

Name	Key	Required	Type	Description
Campaign Description	description	True	string	A description of the campaign
Start Date	startdate		date	The start date of the campaign
Expiration Date	expires	True	date	Date the campaign expires
Total Budget	budget	True	float	The total budget for the campaign
Promotion Category	promotype		string	The type or category of the campaign (such as Google Search)
Employee (Manager)	manager		string	The employee who manages the campaign

Returns

response: object

Create New ComLog

Operation ID:: ComLog_PostValue

New Communication Entry

Parameters

Name	Key	Type	Description
Contact ID	contactid	string	The contact ID of the communication (blank for lead)
Lead ID	leadid	string	The Lead ID of the communication (zero for contact based)
Communication Type	type	string	E-Mail, Phone-call, etc
Subject	subject	string	Subject of communication
Content of the communication	body	string	body
Employee Name	employee	string	CRM Employee name who performed action
Start Time of Communication	starttime	string	starttime
End Time	endtime	string	endtime
Work Order Link	workorder	string	Work order number of communication
Project ID	project	string	Project linked to communication
Marketing campaign	campaign	string	The marketing campaign linked to the communication
Length of communication	length	number	length
Is Billed	billed	boolean	Has the communication entry been billed by the CRM
InBound	inbound	boolean	Is communication inbound (false = outbound)

Returns

response: object

Create new CRM Contact

Operation ID:: Contact_PostValue

Creates a qualified prospect, customer or vendor

Parameters

Name	Key	Type	Description
account	account	string	account
sal	sal	string	sal
firstname	firstname	string	firstname
middlename	middlename	string	middlename
title	title	string	title
lastname	lastname	string	lastname
company	company	string	company
addr1	addr1	string	addr1
addr2	addr2	string	addr2
city	city	string	city
state	state	string	state
postal	postal	string	postal
email1	email1	string	email1
email2	email2	string	email2
email3	email3	string	email3
email4	email4	string	email4
phonetype1	phonetype1	string	phonetype1
phone1	phone1	string	phone1
phonetype2	phonetype2	string	phonetype2
phone2	phone2	string	phone2
phonetype3	phonetype3	string	phonetype3
phone3	phone3	string	phone3
phonetype4	phonetype4	string	phonetype4
phone4	phone4	string	phone4
remark	remark	string	remark
notes	notes	string	notes
campaign	campaign	string	campaign
category	category	string	category
market	market	string	market
territory	territory	string	territory
salesrep	salesrep	string	salesrep
lastcontact	lastcontact	date-time	lastcontact

Returns

response: object

Create New FollowUp

Operation ID:: FollowUp_PostValue

Creates a new followup

Parameters

Name	Key	Type	Description
Contact ID	contactid	string	The contact ID linked to the followup (blank for lead)
Lead ID	leadid	string	The lead ID of the followup (0 for contact)
Follow Up Type	type	string	The type of the follow up (Call Back, GoToMeeting, etc)
Comments or Instructions	comments	string	Comments or Instructions related to the followup
Employee Assigned To	assignedto	string	The employee name assigned to the followup
Employee Set By	setby	string	The employee name that set the followup
Due Date	duedate	string	The due date of the followup
Is Urgent	urgent	boolean	Is this followup urgent
Reminder Minutes	reminderminutes	number	Number of minutes before event for reminder (0 = none)
Is Cleared	cleared	boolean	Is this followup Cleared

Returns

response: object

Create New Item

Operation ID:: ItemList_PostValue

All tags are required to be present, even if blank.

Parameters

Name	Key	Type	Description
Part Number or SKU	modelno	string	The part number, Model Number or SKU of the item
Item Description	descrip	string	Sales description of item
Item Type	itemtype	string	The type of the item (Inventory,NonInv,Misc,Discount,Service)
Sales Price	price	number	The sales price of the item
Item Cost	cost	number	Last and Average cost of item
Vendor Name	vendor	string	The vendor name purchased from

Returns

Name	Path	Type	Description
New Code ID	id	string	New Code ID

Create New Lead

Operation ID:: Lead_PostValue

Creates a new sales lead

Parameters

Name	Key	Type	Description
Saluation	sal	string	Mr, Ms, etc
First Name	firstname	string	First Name
Middle Name	middlename	string	Optional
Contact Title	title	string	Owner, VP, etc
Last Name	lastname	string	Last Name
Company Name	company	string	Optional
Address Line 1	addr1	string	Address Line 1
Address Line 2	addr2	string	Optional
Address City	city	string	Address City
Address State	state	string	State or Region
Address Zip or Postal	postal	string	Zip Code or Postal Code
Primary EMail	email1	string	Email 1
EMail 2	email2	string	Email 2
EMail 3	email3	string	Email 3
EMail 4	email4	string	EMail 4
Primary Phone Type	phonetype1	string	Home, Work, Cell, etc
Primary Phone	phone1	string	(xxx) xxx-xxxx
Phone Type 2	phonetype2	string	Work, Cell, Fax, etc
Alternate Phone	phone2	string	Phone 2
Phone Type 3	phonetype3	string	Work, Cell, Fax, etc
Alternate Phone	phone3	string	Phone 3
Phone Type 4	phonetype4	string	Work, Cell, Fax, Ettc
Alternate Phone	phone4	string	Phone 4
Quick Remark	remark	string	A short remark
Contact Notes	notes	string	General Notes
Campaign Name	campaign	string	The name (not the ID) of the marketing source
Lead Category	category	string	Category for the lead (such as Hot Lead, etc)
Contact Role	role	string	Decision maker, etc
Market Description	market	string	Description of market (Industrial, Bakeries, etc)
Territory	territory	string	East, North, etc
Sales Rep Name	salesrep	string	The sales rep name (blank for unassigned)
Last Contact Date	lastcontact	string	date of last contact

Returns

response: object

Create New Order

Operation ID:: SO_PostValue

Creates a new order

Parameters

Name	Key	Type	Description
Order ID	orderid	string	External Order ID
Order Date	orderdate	string	Date of Order
Order Description	orderdescription	string	External Order Description
Account Number	account	string	Account number of customer (blank for new account)
Customer Name	accountname	string	Name of customer (becomes QB account name)
Sales Rep Name	salesrep	string	Name of sales rep (blank for none)
First Name	firstname	string	Contact First Name
Last Name	lastname	string	Contact Last Name
Billing EMail	billemail	string	Email address of billing contact
Billing Address 1	billaddr1	string	Address line 1
Billing Address 2	billaddr2	string	Address Line 2
Billing City	billcity	string	City or Region
Billing State	billstate	string	State or province
Billing Zip Code	billzipcode	string	zip or postal code
Billing Country	billcountry	string	Name of Country (United States, Canada, etc)
Billing Phone	billphone	string	phone number of billing contact
Billing Fax	billfax	string	Fax number of billing contact
Ship To Company	shipcompany	string	Company Name
Ship To Contact	shipcontact	string	Attention Contact
Shipping Line 1	shipaddr1	string	Address line 1
Shipping Line 2	shipaddr2	string	Address Line 2
Shipping City	shipcity	string	Shipping City or Region
Shipping State	shipstate	string	State or Region
Shipping Zip	shipzipcode	string	Zip or Postal code
Ship To Country	shipcountry	string	United States, Canada, etc
Ship To Phone	shipphone	string	shipping phone number
Ship To EMail	shipemail	string	Shipping EMail address
Order Status	orderstatus	string	Primary status of incoming order
Custom Status	customstatus	string	In Fulfillment, Pending Review, etc
Tax District	taxdistrict	string	CA, FL, etc
Tax Rate	taxrate	float	Applied tax rate
Campaign Name	campaign	string	Where order originated from (Google Search, etc)
Order Tax	ordertax	string	Total tax of order
Shipping Cost	shippingcost	string	Shipping cost billed on cart
Shipping Method	shippingmethod	string	Preferred shipping method (UPS, etc)
Coupone Amount	couponamount	number	amount of coupon
Coupon Code	couponcode	string	Black Friday Sale, etc
Payment Method	paymentmethod	string	Visa, MC, etc
Order Comments	comments	string	comments related to order
Item Qty	qty	number	Line Item Qty
Model Number	modelno	string	SKU of line item
Item Description	description	string	Description of line item
Order Line Item Comments	comments	string	Item Related Comments
Item Price	price	double	Line Item Price
Item Discount	discount	string	Discount of line item (positive value)

Returns

response: object

Create New Shipment

Operation ID:: Shipping_PostValue

Creates a shipment

Parameters

Name	Key	Type	Description
Order ID	orderid	string	ID of order to ship
Shipping Date	shipdate	string	Date of shipment
Shipping Carrier	carrier	string	UPS, Fedex, etc
Shipping Method	method	string	Ground, Next Day Air, etc
Package Weight	weight	number	Weight of shipment
Packaging Type	packagetype	string	Other, Box, Envelope, etc
Reference 1	reference1	string	PO Number, etc
Reference 2	reference2	string	BOL, etc
Tracking Number	trackingnumber	string	Carrier Tracking Number
Tracking URL	trackingurl	string	URL to track shipment
Shipment Cost	shippingcost	number	Cost of shipment
Order In History	tohistory	boolean	Is this order complete?

Returns

response: object

Create New WorkOrder

Operation ID:: WorkOrder_PostValue

New Work-Order

Parameters

Name	Key	Type	Description
Contact EMail	fromaddress	string	Email address of customer requesting work order
First Name	firstname	string	First Name
Last Name	lastname	string	Last Name
Company Name	companyname	string	Company Name
Billing Address 1	billaddr1	string	Address line 1
Billing Address 2	billaddr2	string	Address Line 2
Billing City	billcity	string	Bill city
Billing State	billstate	string	Billing state or region
Billing Zip	billzipcode	string	Bill zip or postal
Billing Country	billcountry	string	United States, Canada, etc
Billing Phone Number	billphone	string	billing phone number
Billing Fax	billfax	string	Bill fax number
Service Address 1	serviceaddr1	string	address to perform service
Service Address 2	serviceaddr2	string	address to perform service
Service City	servicecity	string	address to perform service
Service State	servicestate	string	address to perform service
Service Zip	servicezipcode	string	zip or postal code
Service Country	servicecountry	string	address to perform service
Service Phone Number	servicephone	string	(xxx) xxx-xxxx
Received Date	receiveddate	string	date time workorder was received
PO Number	ponumber	string	Customer PO Number
Status	status	string	Open,Pending Review, etc
Reason Code	reasoncode	string	Customer Request,Warranty,etc
Source	source	string	EMail, web, phone call etc
Assigned Technician	assignedto	string	blank for unassigned
Backup Technician	backup	string	blank for unassigned
Priority	priority	string	Work Order Priority (0 Urgent = 4 Low)
Due Date	duedate	string	Work order due by date
Subject	subject	string	Brief summary of request
WO Content	body	string	Descriptive text of Work Order

Returns

response: object

Get Active Leads

Operation ID:: Lead_GetValues

Returns a list of active sales leads

Returns

Name	Path	Type	Description
		array of string

Get Active Orders

Operation ID:: SO_GetValues

Returns a list of active orders

Returns

Name	Path	Type	Description
		array of string

Get Campaign List

Operation ID:: Campaign_GetValues

Returns a list of campaigns

Returns

Name	Path	Type	Description
		array of string

Get ComLogs

Operation ID:: ComLog_GetValues

Returns a list of requested communication ID's

Returns

Name	Path	Type	Description
		array of string

Get Contact List

Operation ID:: Contact_GetValues

retrieves a list of contacts

Returns

Name	Path	Type	Description
		array of string

Get FollowUp List

Operation ID:: FollowUp_GetValues

Retrieve list of followups

Returns

Name	Path	Type	Description
		array of string

Get Item List

Operation ID:: ItemList_GetValues

Returns a list of all items

Returns

Name	Path	Type	Description
		array of string

Get Member List

Operation ID:: Members_GetValues

Marketing campaign members

Parameters

Name	Key	Required	Type	Description
Supply L, C or B (required)	type	True	string	Type of campaign member (Lead, Contact or Both)

Returns

Name	Path	Type	Description
		array of string

Get Shipment List

Operation ID:: Shipping_GetValues

Returns a list of shipments

Returns

Name	Path	Type	Description
		array of string

Get WorkOrder List

Operation ID:: WorkOrder_GetValues

List of workorders

Returns

Name	Path	Type	Description
		array of string

Remove Campaign Member

Operation ID:: Members_PutValue

Removes a marketing campaign member

Parameters

Name	Key	Required	Type	Description
Member ID	id	True	string	Member ID
Operation	operation		string	only Remove supported at this time
Record Type	recordtype		string	L for Lead, C for contact
Campaign ID	promoid		string	ID of campaign
Record ID	recordid		string	Numeric id of lead or alphanumeric id of contact

Returns

response: object

Retrieve Campaign Details

Operation ID:: Campaign_GetValue

Retrieves the details of a specific campaign request by id

Parameters

Name	Key	Required	Type	Description
Campaign ID	id	True	string	Campaign ID

Returns

Name	Path	Type	Description
PromoID	PromoID	string	PromoID
Campaign Manager	Campaign Manager	string	Campaign Manager
IS INACTIVE	IS INACTIVE	string	IS INACTIVE
IN HISTORY	IN HISTORY	string	IN HISTORY
Used For Discounting	Used For Discounting	string	Used For Discounting
Used For Mail Broadcasting	Used For Mail Broadcasting	string	Used For Mail Broadcasting
budget	budget	string	budget
Promotion Type	Promotion Type	string	Promotion Type
description	description	string	description
Employee Name	Employee Name	string	Employee Name
Start Date	Start Date	string	Start Date
Expiration Date	Expiration Date	string	Expiration Date
Revenue	Revenue	string	Revenue

Retrieve ComLog Details

Operation ID:: ComLog_GetValue

Returns field details

Parameters

Name	Key	Required	Type	Description
Communication ID	id	True	string	Communication ID

Returns

Name	Path	Type	Description
Direction	Direction	string	Direction
account	account	string	account
Account Name	Account Name	string	Account Name
Contact Name	Contact Name	string	Contact Name
Start Date	Start Date	string	Start Date
End Date	End Date	string	End Date
Employee Name	Employee Name	string	Employee Name
Type	Type	string	Type
Length	Length	string	Length
Subject	Subject	string	Subject
Content	Content	string	Content
Billed	Billed	string	Billed
Work Order	Work Order	string	Work Order
Sales Order	Sales Order	string	Sales Order
Sales Lead	Sales Lead	string	Sales Lead
Project ID	Project ID	string	Project ID
Recipient	Recipient	string	Recipient
cc	cc	string	cc
Bcc	Bcc	string	Bcc
CallNumber	CallNumber	string	CallNumber
RecordID	RecordID	string	RecordID
Company Name	Company Name	string	Company Name

Retrieve CRM Contact Details

Operation ID:: Contact_GetValue

Retrieves details about the specified contact

Parameters

Name	Key	Required	Type	Description
Contact ID	id	True	string	Contact ID

Returns

response: object

Retrieve followup Details

Operation ID:: FollowUp_GetValue

Followup details

Parameters

Name	Key	Required	Type	Description
Follow Up ID	id	True	string	Follow Up ID

Returns

Name	Path	Type	Description
account	account	string	account
RecallID	RecallID	string	RecallID
Employee Name	Employee Name	string	Employee Name
SET FOR	SET FOR	string	SET FOR
SET BY	SET BY	string	SET BY
SET ON	SET ON	string	SET ON
IS CLEARED	IS CLEARED	string	IS CLEARED
Cleared By	Cleared By	string	Cleared By
Cleared On	Cleared On	string	Cleared On
ACCOUNT TYPE	ACCOUNT TYPE	string	ACCOUNT TYPE
Priority	Priority	string	Priority
TYPE	TYPE	string	TYPE
Details	Details	string	Details
Account Name	Account Name	string	Account Name
First Name	First Name	string	First Name
Last Name	Last Name	string	Last Name
Company Name	Company Name	string	Company Name
FollowUp Date	FollowUp Date	string	FollowUp Date
Reminder Time	Reminder Time	string	Reminder Time
WORK ORDER	WORK ORDER	string	WORK ORDER
Sales Lead	Sales Lead	string	Sales Lead
Project ID	Project ID	string	Project ID

Retrieve Item Details

Operation ID:: ItemList_GetValue

Details about a specific item

Parameters

Name	Key	Required	Type	Description
Item Id	id	True	string	Item id

Returns

Name	Path	Type	Description
Code	Code	string	Code
Model Number	Model Number	string	Model Number
Description	Description	string	Description
Sales Description	Sales Description	string	Sales Description
Purchase Description	Purchase Description	string	Purchase Description
Item Type	Item Type	string	Item Type
Base Price	Base Price	string	Base Price
Avg Cost	Avg Cost	string	Avg Cost
Primary Category	Primary Category	string	Primary Category
Category2	Category2	string	Category2
Category3	Category3	string	Category3
Category4	Category4	string	Category4
Category5	Category5	string	Category5
Base UOM	Base UOM	string	Base UOM
Sell UOM	Sell UOM	string	Sell UOM
Buy UOM	Buy UOM	string	Buy UOM
Base Warehouse	Base Warehouse	string	Base Warehouse
On Hand	On Hand	string	On Hand
On SO	On SO	string	On SO
Bad	Bad	string	Bad
On WO	On WO	string	On WO
On PO	On PO	string	On PO
Available	Available	string	Available
Taxable	Taxable	string	Taxable
Tax 2	Tax 2	string	Tax 2
Pays Commission	Pays Commission	string	Pays Commission
Fixed Price	Fixed Price	string	Fixed Price
Discounting Prohibited	Discounting Prohibited	string	Discounting Prohibited
Call For Price	Call For Price	string	Call For Price
Call For Cost	Call For Cost	string	Call For Cost
Gratis Item	Gratis Item	string	Gratis Item
Hidden on Printouts	Hidden on Printouts	string	Hidden on Printouts
Exclude From Margin	Exclude From Margin	string	Exclude From Margin
Track Serial Numbers	Track Serial Numbers	string	Track Serial Numbers
Serialization Mode	Serialization Mode	string	Serialization Mode
Serial Number Required	Serial Number Required	string	Serial Number Required
Prohibit Duplicate Serial Numbers	Prohibit Duplicate Serial Numbers	string	Prohibit Duplicate Serial Numbers
Expiration Date Applies	Expiration Date Applies	string	Expiration Date Applies
Shipping Charges Apply	Shipping Charges Apply	string	Shipping Charges Apply
Item must ship seperately	Item must ship seperately	string	Item must ship seperately
Group Ship Items	Group Ship Items	string	Group Ship Items
Drop-Ship From Vendor	Drop-Ship From Vendor	string	Drop-Ship From Vendor
Height	Height	string	Height
Width	Width	string	Width
Depth	Depth	string	Depth
Weight	Weight	string	Weight
Box Limit	Box Limit	string	Box Limit
Lead Time	Lead Time	string	Lead Time
Last Cost	Last Cost	string	Last Cost
Reorder Point	Reorder Point	string	Reorder Point
Item Message	Item Message	string	Item Message
ON SALE	ON SALE	string	ON SALE
IS ASSEMBLY	IS ASSEMBLY	string	IS ASSEMBLY
Manufacturer Part Number	Manufacturer Part Number	string	Manufacturer Part Number
OEM	OEM	string	OEM
BIN Location	BIN Location	string	BIN Location
Primary Vendor	Primary Vendor	string	Primary Vendor
Vendor 1 Part #	Vendor 1 Part #	string	Vendor 1 Part #
Vendor 1 Descrip	Vendor 1 Descrip	string	Vendor 1 Descrip
Vendor 1 Cost	Vendor 1 Cost	string	Vendor 1 Cost
Vendor 1 Date Cost Verified	Vendor 1 Date Cost Verified	string	Vendor 1 Date Cost Verified
Vendor 2	Vendor 2	string	Vendor 2
Vendor 2 Part #	Vendor 2 Part #	string	Vendor 2 Part #
Vendor 2 Descrip	Vendor 2 Descrip	string	Vendor 2 Descrip
Vendor 2 Cost	Vendor 2 Cost	string	Vendor 2 Cost
Vendor 2 Date Cost Verified	Vendor 2 Date Cost Verified	string	Vendor 2 Date Cost Verified
Vendor 3	Vendor 3	string	Vendor 3
Vendor 3 Part #	Vendor 3 Part #	string	Vendor 3 Part #
Vendor 3 Descrip	Vendor 3 Descrip	string	Vendor 3 Descrip
Vendor 3 Cost	Vendor 3 Cost	string	Vendor 3 Cost
Vendor 3 Date Cost Verified	Vendor 3 Date Cost Verified	string	Vendor 3 Date Cost Verified
Vendor 4	Vendor 4	string	Vendor 4
Vendor 4 Part #	Vendor 4 Part #	string	Vendor 4 Part #
Vendor 4 Descrip	Vendor 4 Descrip	string	Vendor 4 Descrip
Vendor 4 Cost	Vendor 4 Cost	string	Vendor 4 Cost
Vendor 4 Date Cost Verified	Vendor 4 Date Cost Verified	string	Vendor 4 Date Cost Verified
Vendor 5	Vendor 5	string	Vendor 5
Vendor 5 Part #	Vendor 5 Part #	string	Vendor 5 Part #
Vendor 5 Descrip	Vendor 5 Descrip	string	Vendor 5 Descrip
Vendor 5 Cost	Vendor 5 Cost	string	Vendor 5 Cost
Vendor 5 Date Cost Verified	Vendor 5 Date Cost Verified	string	Vendor 5 Date Cost Verified
Price Level Mode	Price Level Mode	string	Price Level Mode
Price Level 2	Price Level 2	string	Price Level 2
Price Level 3	Price Level 3	string	Price Level 3
Price Level 4	Price Level 4	string	Price Level 4
Price Level 5	Price Level 5	string	Price Level 5
Price Level 6	Price Level 6	string	Price Level 6
Price Level 7	Price Level 7	string	Price Level 7
Price Level 8	Price Level 8	string	Price Level 8
Price Level 9	Price Level 9	string	Price Level 9
Price Level 10	Price Level 10	string	Price Level 10
Price Level 11	Price Level 11	string	Price Level 11
Price Level 12	Price Level 12	string	Price Level 12
Price Level 13	Price Level 13	string	Price Level 13
Price Level 14	Price Level 14	string	Price Level 14
Price Level 15	Price Level 15	string	Price Level 15
Price Level 16	Price Level 16	string	Price Level 16
Price Level 17	Price Level 17	string	Price Level 17
Price Level 18	Price Level 18	string	Price Level 18
Price Level 19	Price Level 19	string	Price Level 19
Price Level 20	Price Level 20	string	Price Level 20
Quantity Level 1	Quantity Level 1	string	Quantity Level 1
Quantity Price 1	Quantity Price 1	string	Quantity Price 1
Quantity Price Level 1	Quantity Price Level 1	string	Quantity Price Level 1
Quantity Level 2	Quantity Level 2	string	Quantity Level 2
Quantity Price 2	Quantity Price 2	string	Quantity Price 2
Quantity Price Level 2	Quantity Price Level 2	string	Quantity Price Level 2
Quantity Level 3	Quantity Level 3	string	Quantity Level 3
Quantity Price 3	Quantity Price 3	string	Quantity Price 3
Quantity Price Level 3	Quantity Price Level 3	string	Quantity Price Level 3
Quantity Level 4	Quantity Level 4	string	Quantity Level 4
Quantity Price 4	Quantity Price 4	string	Quantity Price 4
Quantity Price Level 4	Quantity Price Level 4	string	Quantity Price Level 4
Quantity Level 5	Quantity Level 5	string	Quantity Level 5
Quantity Price 5	Quantity Price 5	string	Quantity Price 5
Quantity Price Level 5	Quantity Price Level 5	string	Quantity Price Level 5
Quantity Level 6	Quantity Level 6	string	Quantity Level 6
Quantity Price 6	Quantity Price 6	string	Quantity Price 6
Quantity Price Level 6	Quantity Price Level 6	string	Quantity Price Level 6
Quantity Level 7	Quantity Level 7	string	Quantity Level 7
Quantity Price 7	Quantity Price 7	string	Quantity Price 7
Quantity Price Level 7	Quantity Price Level 7	string	Quantity Price Level 7
Quantity Level 8	Quantity Level 8	string	Quantity Level 8
Quantity Price 8	Quantity Price 8	string	Quantity Price 8
Quantity Price Level 8	Quantity Price Level 8	string	Quantity Price Level 8
Quantity Level 9	Quantity Level 9	string	Quantity Level 9
Quantity Price 9	Quantity Price 9	string	Quantity Price 9
Quantity Price Level 9	Quantity Price Level 9	string	Quantity Price Level 9
Quantity Level 10	Quantity Level 10	string	Quantity Level 10
Quantity Price 10	Quantity Price 10	string	Quantity Price 10
Quantity Price Level 10	Quantity Price Level 10	string	Quantity Price Level 10

Retrieve Lead Details

Operation ID:: Lead_GetValue

retrieves the lead details

Parameters

Name	Key	Required	Type	Description
Lead ID	id	True	string	Lead ID

Returns

Name	Path	Type	Description
type	type	string	type
leadid	leadid	string	leadid
Category	Category	string	Category
recordid	recordid	string	recordid
Company Name	Company Name	string	Company Name
Salutation	Salutation	string	Salutation
First Name	First Name	string	First Name
Last Name	Last Name	string	Last Name
Address Line 1	Address Line 1	string	Address Line 1
Address Line 2	Address Line 2	string	Address Line 2
City	City	string	City
State	State	string	State
Postal Code	Postal Code	string	Postal Code
Country	Country	string	Country
Time-Zone	Time-Zone	string	Time-Zone
Latitude	Latitude	string	Latitude
Longitude	Longitude	string	Longitude
Title	Title	string	Title
Contact Type	Contact Type	string	Contact Type
Sales Rep	Sales Rep	string	Sales Rep
Phone Extension	Phone Extension	string	Phone Extension
Last Contact Date	Last Contact Date	string	Last Contact Date
Contact Notes	Contact Notes	string	Contact Notes
Quick Remark	Quick Remark	string	Quick Remark
Created Date	Created Date	string	Created Date
Market	Market	string	Market
Sales Territory	Sales Territory	string	Sales Territory
Primary Email	Primary Email	string	Primary Email
EMail 2	EMail 2	string	EMail 2
Email 3	Email 3	string	Email 3
Email 4	Email 4	string	Email 4
OPTOUT	OPTOUT	string	OPTOUT
Phone1	Phone1	string	Phone1
Phone2	Phone2	string	Phone2
Phone3	Phone3	string	Phone3
Phone4	Phone4	string	Phone4
Promotion Memberships	Promotion Memberships	string	Promotion Memberships
Source	Source	string	Source
Source Notes	Source Notes	string	Source Notes
Website	Website	string	Website
Twitter	Twitter	string	Twitter
Facebook	Facebook	string	Facebook
LinkedIn	LinkedIn	string	LinkedIn
Product Interest	Product Interest	string	Product Interest
Assigned To Rep	Assigned To Rep	string	Assigned To Rep

Retrieve Member Details

Operation ID:: Members_GetValue

retrieve details about a member

Parameters

Name	Key	Required	Type	Description
Id of member	id	True	string	Id of member

Returns

Name	Path	Type	Description
Record ID	recordid	string	Record ID (numeric for lead, alpha for contact)
Contact Title	title	string	Mr, Ms, etc
First Name	fname	string	First name
Last Name	lname	string	Last Name
Address Line 1	addr1	string	Address Line 1
Address Line 2	addr2	string	Address Line 2
Address City	city	string	Address City
Address State	state	string	State or Province
Address Zip	zipcode	string	Zip or Postal Code
Primary EMail	email	string	Email
Alternate Email 2	email2	string	Email 2
Alternate Email 3	email3	string	Email 3
Alternate Email 4	email4	string	Email 4
Primary Phone	phone1	string	Phone 1
Alternate Phone 2	phone2	string	Phone 2
Alternate Phone 3	phone3	string	Phone 3
Alternate Phone 4	phone4	string	Phone 4

Retrieve Order Details

Operation ID:: SO_GetValue

Retrieve details of an order

Parameters

Name	Key	Required	Type	Description
SalesOrder ID	id	True	string	id of salesorder

Returns

Name	Path	Type	Description
Order ID	Order ID	string	Order ID
PROCESSING PHASE	PROCESSING PHASE	string	PROCESSING PHASE
Account	Account	string	Account
Account Name	Account Name	string	Account Name
Sales Rep	Sales Rep	string	Sales Rep
Custom Status	Custom Status	string	Custom Status
Description	Description	string	Description
Quotation Date	Quotation Date	string	Quotation Date
Close Date	Close Date	string	Close Date
Ship Date	Ship Date	string	Ship Date
Expiration Date	Expiration Date	string	Expiration Date
Terms	Terms	string	Terms
Marketing Campaign	Marketing Campaign	string	Marketing Campaign
Shipping Warehouse	Shipping Warehouse	string	Shipping Warehouse
FOB	FOB	string	FOB
Deposit Required	Deposit Required	string	Deposit Required
Total Weight	Total Weight	string	Total Weight
Quote Amount	Quote Amount	string	Quote Amount
Partial Shipments OK	Partial Shipments OK	string	Partial Shipments OK
Invoice Shipping	Invoice Shipping	string	Invoice Shipping
IN HISTORY	IN HISTORY	string	IN HISTORY
IS INACTIVE	IS INACTIVE	string	IS INACTIVE
In-Pipeline	In-Pipeline	string	In-Pipeline
Tax 1	Tax 1	string	Tax 1
Tax 2	Tax 2	string	Tax 2
Is Template	Is Template	string	Is Template
Template Name	Template Name	string	Template Name
Customer PO	Customer PO	string	Customer PO
Ship To Company	Ship To Company	string	Ship To Company
Ship To Contact	Ship To Contact	string	Ship To Contact
Ship To Addr 1	Ship To Addr 1	string	Ship To Addr 1
Ship To Addr 2	Ship To Addr 2	string	Ship To Addr 2
Ship To State	Ship To State	string	Ship To State
Ship To Postal Code	Ship To Postal Code	string	Ship To Postal Code
Ship To Country	Ship To Country	string	Ship To Country
Ship To Phone	Ship To Phone	string	Ship To Phone
Ship To EMail	Ship To EMail	string	Ship To EMail
Residential	Residential	string	Residential
Formatted Ship To	Formatted Ship To	string	Formatted Ship To
Paid Amount	Paid Amount	string	Paid Amount
Balance Due	Balance Due	string	Balance Due
QB Invoice Number	QB Invoice Number	string	QB Invoice Number
Confirmed Order	Confirmed Order	string	Confirmed Order
Commission	Commission	string	Commission
TotalCost	TotalCost	string	TotalCost
Margin	Margin	string	Margin
Project ID	Project ID	string	Project ID
Next Appointment	Next Appointment	string	Next Appointment
Appointment With	Appointment With	string	Appointment With
linedata:	linedata:	array of object	linedata:
itemid	linedata:.itemid	string	itemid
orderqty	linedata:.orderqty	string	orderqty
uom	linedata:.uom	string	uom
modelno	linedata:.modelno	string	modelno
descrip	linedata:.descrip	string	descrip
comments	linedata:.comments	string	comments
shippedqty	linedata:.shippedqty	string	shippedqty
price	linedata:.price	string	price
subttl	linedata:.subttl	string	subttl
total	linedata:.total	string	total

Retrieve Shipment Details

Operation ID:: Shipping_GetValue

get shipment details

Parameters

Name	Key	Required	Type	Description
Order ID	id	True	string	desired Order ID

Returns

Name	Path	Type	Description
Customer	Customer	string	Customer
Order ID	Order ID	string	Order ID
Model Number	Model Number	string	Model Number
Descrip	Descrip	string	Descrip
Shipped Qty	Shipped Qty	string	Shipped Qty
BoxID	BoxID	string	BoxID
Tracking	Tracking	string	Tracking
Ship Date	Ship Date	string	Ship Date
Shipped By	Shipped By	string	Shipped By
SerialData	SerialData	string	SerialData
Ship_Company	Ship_Company	string	Ship_Company
Ship_Contact	Ship_Contact	string	Ship_Contact
Ship_Addr1	Ship_Addr1	string	Ship_Addr1
Ship_Addr2	Ship_Addr2	string	Ship_Addr2
Ship_City	Ship_City	string	Ship_City
Ship_State	Ship_State	string	Ship_State
Ship_ZipCode	Ship_ZipCode	string	Ship_ZipCode
Ship_Phone	Ship_Phone	string	Ship_Phone
Carrier	Carrier	string	Carrier
ShipmentID	ShipmentID	string	ShipmentID
ItemID	ItemID	string	ItemID

Retrieve WorkOrder Details

Operation ID:: WorkOrder_GetValue

Returns details of a WO

Parameters

Name	Key	Required	Type	Description
Workorder ID	id	True	string	id of workorder

Returns

Name	Path	Type	Description
Work Order Number	Work Order Number	string	Work Order Number
IN HISTORY	IN HISTORY	string	IN HISTORY
INACTIVE	INACTIVE	string	INACTIVE
Priority	Priority	string	Priority
account	account	string	account
Customer Name	Customer Name	string	Customer Name
summary	summary	string	summary
Content	Content	string	Content
Assigned To	Assigned To	string	Assigned To
Backup Assignment	Backup Assignment	string	Backup Assignment
Received Date	Received Date	string	Received Date
Due By	Due By	string	Due By
Opened-By	Opened-By	string	Opened-By
CONTRACT ID	CONTRACT ID	string	CONTRACT ID
Source	Source	string	Source
Custom Status	Custom Status	string	Custom Status
Reason Code	Reason Code	string	Reason Code
Customer Reference Number	Customer Reference Number	string	Customer Reference Number
Service-To Company	Service-To Company	string	Service-To Company
Service-To Contact	Service-To Contact	string	Service-To Contact
Service-To Address Line 1	Service-To Address Line 1	string	Service-To Address Line 1
Service-To Address Line 2	Service-To Address Line 2	string	Service-To Address Line 2
Service-To City	Service-To City	string	Service-To City
Service-To State	Service-To State	string	Service-To State
Service-To Postal Code	Service-To Postal Code	string	Service-To Postal Code
Service-To Phone	Service-To Phone	string	Service-To Phone
Service-To Country	Service-To Country	string	Service-To Country
Service-To County	Service-To County	string	Service-To County
Latitude	Latitude	string	Latitude
Longitude	Longitude	string	Longitude
Time-Zone	Time-Zone	string	Time-Zone
Formatted Service Address	Formatted Service Address	string	Formatted Service Address
Created Date	Created Date	string	Created Date
Customer Email	Customer Email	string	Customer Email
Customer PO	Customer PO	string	Customer PO
Service Appointment	Service Appointment	string	Service Appointment
Project ID	Project ID	string	Project ID
Total Charge	Total Charge	string	Total Charge
Time Spent	Time Spent	string	Time Spent

Update Campaign Data

Operation ID:: Campaign_PutValue

Updates a marketing campaign in the CRM

Parameters

Name	Key	Required	Type	Description
Campaign ID	id	True	string	Campaign ID
Description	description		string	Updated description for the campaign
Start Date	startdate		string	What is the campaign start date
Updated Expiration	expires		string	Updated expiration for the campaign
Updated Budget	budget		float	Updated budget for the campaign
Campaign Manager	manager		string	Which employee manages the campaign
In History	history		boolean	Is the campaign in history

Returns

response: object

Update Comlog Data

Operation ID:: ComLog_PutValue

Updates a communication entry

Parameters

Name	Key	Required	Type	Description
Communication ID	id	True	string	Communication ID
Communication Type	type		string	The type of the event
Subject	subject		string	The subject of the event
Content Body	body		string	The message content
Employee Name	employee		string	The employee name that performed the action
Start Date/Time	starttime		string	The event start date/time
End Time	endtime		string	The end time of the communication
Workorder ID	workorder		string	The work order number linked to the event
Project ID	project		string	The project ID of the communication
Campaign Link	campaign		string	The ID of the linked campaign
Event Length	length		number	How long the event took place
Is Billed	billed		boolean	Has entry been invoiced in the CRM
Inbound	inbound		boolean	Was the communication inbound

Update CRM Contact Data

Operation ID:: Contact_PutValue

Update the specified CRM contact

Parameters

Name	Key	Required	Type	Description
Contact ID	id	True	string	Contact ID
sal	sal		string	sal
firstname	firstname		string	firstname
middlename	middlename		string	middlename
title	title		string	title
lastname	lastname		string	lastname
company	company		string	company
addr1	addr1		string	addr1
addr2	addr2		string	addr2
city	city		string	city
state	state		string	state
postal	postal		string	postal
email1	email1		string	email1
email2	email2		string	email2
email3	email3		string	email3
email4	email4		string	email4
phonetype1	phonetype1		string	phonetype1
phone1	phone1		string	phone1
phonetype2	phonetype2		string	phonetype2
phone2	phone2		string	phone2
phonetype3	phonetype3		string	phonetype3
phone3	phone3		string	phone3
phonetype4	phonetype4		string	phonetype4
phone4	phone4		string	phone4
remark	remark		string	remark
notes	notes		string	notes
campaign	campaign		string	campaign
category	category		string	category
market	market		string	market
territory	territory		string	territory
salesrep	salesrep		string	salesrep
lastcontact	lastcontact		date-time	lastcontact

Returns

response: object

Update followup Data

Operation ID:: FollowUp_PutValue

Updates a followup

Parameters

Name	Key	Required	Type	Description
Follow Up ID	id	True	string	Follow Up ID
Followup Type	type		string	The type of the followup (call back, gotomeeting, etc)
Note or Comments	comments		string	Comments or Instructions related to followup
Employee Assigned To	assignedto		string	Employee name assigned to followup
Employee Set By	setby		string	Name of employee who set the followup
Due Date	duedate		string	Due date of followup
Is Urgent	urgent		string	Is this followup Urgent
Reminder Minutes	reminderminutes		number	Reminder minutes of followup (0=none)
Is Cleared	cleared		boolean	Is this followup cleared

Update Item Data

Operation ID:: ItemList_PutValue

Updates an existing item

Parameters

Name	Key	Required	Type	Description
Item ID	id	True	string	Item ID
Updated Description	descrip		string	The updated description for the item
Updated Price	price		number	The updated price for the item
Updated Cost	cost		number	The updated average and last cost of the item
Updated Vendor	vendor		string	The updated vendor for the item

Update Lead Data

Operation ID:: Lead_PutValue

Update an existing sales lead

Parameters

Name	Key	Required	Type	Description
Lead ID	id	True	string	Lead ID
Salutation	sal		string	Mr, Ms, Etc
First Name	firstname		string	First Name
Middle Name	middlename		string	optional
Contact Title	title		string	VP, Owner, Janitor, etcf
Last Name	lastname		string	Required
Company Name	company		string	Optional
Address Line 1	addr1		string	Address Line 1
Address Line 2	addr2		string	Address Line 2
Address City	city		string	Address City
Address State	state		string	State or Region
Address Zip or Postal	postal		string	Zip or postal code
Primary EMail	email1		string	Email 1
EMail 2	email2		string	Alternate Email
EMail 3	email3		string	Alternate EMail
EMail 4	email4		string	Alternate EMail
Phone Type 1	phonetype1		string	Cell, Fax, etc
Primary Phone	phone1		string	(xxx) xxx-xxxx
Phone Type 2	phonetype2		string	Cell, Fax, etc
Phone 2	phone2		string	alternate phone
Phone Type 3	phonetype3		string	Cell, Fax, etc
Phone 3	phone3		string	alternate phone
Phone Type 4	phonetype4		string	Cell, fax, etc
Phone 4	phone4		string	alternate phone
Quick Remark	remark		string	A short remark
Contact Notes	notes		string	General notes
Marketing Campaign	campaign		string	Description (not ID) of the marketing campaign
Category	category		string	Hot Lead, etc
Contact Role	role		string	Decision Maker, etc
Market Name	market		string	Description of market (Bakeries, Chemical Factory, etc)
Territory Name	territory		string	North, South, etc
Sales Rep Name	salesrep		string	Blank for unassigned
Last Contact Date	lastcontact		string	date of last communication

Returns

response: object

Update Order Data

Operation ID:: SO_PutValue

Updates an existing order

Parameters

Name	Key	Required	Type	Description
Order ID	id	True	string	Order ID
Additional order comments	comments		string	appends order comments
Update Custom Status	customstatus		string	Pending Review, Confirmed, etc
Official Order Status	orderstatus		string	quote,confirmed,shipping,history

Update Shipment Data

Operation ID:: Shipping_PutValue

Updates an existing shipment

Parameters

Name	Key	Required	Type	Description
Shipment ID	id	True	string	Shipment ID
Shipment Date	shipdate		string	date of shipment
Shipment Carrier	carrier		string	UPS, Fedex, etc
Shipping Method	method		string	Ground, Next Day Air, etc
Shipment Weight	weight		number	weight of shipment
Package Type	packagetype		string	Box, Envelope, etc
Reference 1	reference1		string	PO Number,etc
Reference 2	reference2		string	BOL number, etc
Tracking Number	trackingnumber		string	Carrier Tracking Number
Tracking URL	trackingurl		string	Carrier Tracking URL
Shipping Cost	shippingcost		number	cost of shipment

Update WorkOrder Data

Operation ID:: WorkOrder_PutValue

Updates an existing WO

Parameters

Name	Key	Required	Type	Description
WorkOrder ID	id	True	string	Workorder ID
PO Number	ponumber		string	Customer PO Number
Status	status		string	Custom status (Work In Progress,etc)
Reason	reasoncode		string	Reason for request
Source	source		string	Email,Phone,Web, etc
Assigned Technician	assignedto		string	The employee name the WO is assigned to
Assigned Backup	backup		string	The employee name of the backup technician
Priority	priority		string	0(Critical) to 4-(Low)
Due Date	duedate		string	due by date
Subject	subject		string	A brief summary of the request
WO Content	body		string	The body of the request
In History	history		boolean	places workorder in history

Triggers

New Lead Campaign Members	triggers when a lead has been added to a campaign
New Marketing Campaign Created	triggers when a new marketing campaign is created
New Proposal Created	triggers when a new proposal is created
New Sales Lead Created	triggers when a new sales lead is created
New Sales Order Created	triggers when a new sales order is created
Order In History	triggers when an order is complete and in history
Order In Processing	triggers when an order enters the processing phase
Order Is Shipping	triggers when an order enters the shipping phase
Order Status Has Changed	triggers when the custom status of a quote or order changes
Proposal Needs Approval	triggers when a proposal enters the approval phase
WorkOrder Closed	triggers when a workorder is closed
WorkOrder Created	triggers when a workorder is created
WorkOrder is Past Due	triggers when a workorder is past the due date
WorkOrder Status Changed	triggers when the status of the workorder has changed

New Lead Campaign Members

Operation ID:: New-Members-Leads

triggers when a lead has been added to a campaign

Parameters

Name	Key	Required	Type	Description
Specify the campaign ID	PromotionID	True	integer	Campaign ID

Returns

Name	Path	Type	Description
Lead ID	lead id	string	The returned lead id from the request

New Marketing Campaign Created

Operation ID:: New-Marketing-Campaign

triggers when a new marketing campaign is created

Returns

Name	Path	Type	Description
Promotion ID	promoid	string	the Id of the returned promotion

New Proposal Created

Operation ID:: New-Proposal-Created

triggers when a new proposal is created

Returns

Name	Path	Type	Description
Quote ID	Quote ID	string	The quote Id of the request

New Sales Lead Created

Operation ID:: New-Sales-Lead

triggers when a new sales lead is created

Returns

Name	Path	Type	Description
Lead ID	lead id	string	The lead id returned from the request

New Sales Order Created

Operation ID:: New-Sales-Order

triggers when a new sales order is created

Returns

Name	Path	Type	Description
Order ID	Order ID	string	Order ID

Order In History

Operation ID:: Order-In-History

triggers when an order is complete and in history

Returns

Name	Path	Type	Description
Order ID	Order ID	string	the order id of the request

Order In Processing

Operation ID:: Order-In-Processing

triggers when an order enters the processing phase

Returns

Name	Path	Type	Description
Order ID	Order ID	string	the order id of the request

Order Is Shipping

Operation ID:: Order-Is-Shipping

triggers when an order enters the shipping phase

Returns

Name	Path	Type	Description
Order ID	Order ID	string	the order id of the request

Order Status Has Changed

Operation ID:: Order-Status-Changed

triggers when the custom status of a quote or order changes

Parameters

Name	Key	Required	Type	Description
Enter the desired SO Status	Status	True	string	Status Text for Search

Returns

Name	Path	Type	Description
Order ID	Order ID	string	the order id of the request

Proposal Needs Approval

Operation ID:: Proposal-Needs-Approval

triggers when a proposal enters the approval phase

Returns

Name	Path	Type	Description
Quote ID	Quote ID	string	the proposal id of the request

WorkOrder Closed

Operation ID:: WorkOrder-Closed

triggers when a workorder is closed

Returns

Name	Path	Type	Description
Work Order Number	Work Order Number	string	Work Order Number

WorkOrder Created

Operation ID:: WorkOrder-Created

triggers when a workorder is created

Returns

Name	Path	Type	Description
Work Order Number	Work Order Number	string	Work Order Number

WorkOrder is Past Due

Operation ID:: WorkOrder-Past-Due

triggers when a workorder is past the due date

Returns

Name	Path	Type	Description
Work Order Number	Work Order Number	string	Work Order Number

WorkOrder Status Changed

Operation ID:: WorkOrder-Status-Changed

triggers when the status of the workorder has changed

Parameters

Name	Key	Required	Type	Description
The desired WO Status	Status	True	string	Enter WO Status Text

Returns

Name	Path	Type	Description
Work Order Number	Work Order Number	string	Work Order Number

Definitions

object

This is the type 'object'.