Connectors Reference

Imprezian360-CRM

Imprezian360 CRM All-In-One

 

Status: Preview

Tier: Premium

Version: v1

 

Actions:

Name

Summary

Campaign_GetValues ()

Get Campaign List

Campaign_PostValue ([Optional]Campaign_PostValueParameterBody body)

Create New Campaign

Campaign_GetValue (string id)

Retrieve Campaign Details

Campaign_PutValue (string id, [Optional]Campaign_PutValueParameterBody body)

Update Campaign Data

ComLog_GetValues ()

Get ComLogs

ComLog_PostValue ([Optional]ComLog_PostValueParameterBody body)

Create New ComLog

ComLog_GetValue (string id)

Retrieve ComLog Details

ComLog_PutValue (string id, [Optional]ComLog_PutValueParameterBody body)

Update Comlog Data

Contact_GetValues ()

Get Contact List

Contact_PostValue ([Optional]Contact_PostValueParameterBody body)

Create new CRM Contact

Contact_GetValue (string id)

Retrieve CRM Contact Details

Contact_PutValue (string id, [Optional]Contact_PutValueParameterBody body)

Update CRM Contact Data

FollowUp_GetValues ()

Get FollowUp List

FollowUp_PostValue (FollowUp_PostValueParameterBody body)

Create New FollowUp

FollowUp_GetValue (string id)

Retrieve followup Details

FollowUp_PutValue (string id, FollowUp_PutValueParameterBody body)

Update followup Data

ItemList_GetValues ()

Get Item List

ItemList_PostValue ([Optional]ItemList_PostValueParameterBody body)

Create New Item

ItemList_GetValue (string id)

Retrieve Item Details

ItemList_PutValue (string id, [Optional]ItemList_PutValueParameterBody body)

Update Item Data

Lead_GetValues ()

Get Active Leads

Lead_PostValue ([Optional]Lead_PostValueParameterBody body)

Create New Lead

Lead_GetValue (string id)

Retrieve Lead Details

Lead_PutValue (string id, Lead_PutValueParameterBody body)

Update Lead Data

Members_GetValues (string type)

Get Member List

Members_PostValue (Members_PostValueParameterBody body)

Add New Member

Members_GetValue (string id)

Retrieve Member Details

Members_PutValue (string id, Members_PutValueParameterBody body)

Remove Campaign Member

Shipping_GetValues ()

Get Shipment List

Shipping_PostValue (Shipping_PostValueParameterBody body)

Create New Shipment

Shipping_GetValue (string id)

Retrieve Shipment Details

Shipping_PutValue (string id, [Optional]Shipping_PutValueParameterBody body)

Update Shipment Data

SO_GetValues ()

Get Active Orders

SO_PostValue (SO_PostValueParameterBody body)

Create New Order

SO_GetValue (string id)

Retrieve Order Details

SO_PutValue (string id, SO_PutValueParameterBody body)

Update Order Data

WorkOrder_GetValues ()

Get WorkOrder List

WorkOrder_PostValue (WorkOrder_PostValueParameterBody body)

Create New WorkOrder

WorkOrder_GetValue (string id)

Retrieve WorkOrder Details

WorkOrder_PutValue (string id, [Optional]WorkOrder_PutValueParameterBody body)

Update WorkOrder Data

 

Triggers:

Name

Summary

New-Sales-Lead ()

New Sales Lead Created

New-Marketing-Campaign ()

New Marketing Campaign Created

New-Members-Leads (integer PromotionID)

New Lead Campaign Members

New-Sales-Order ()

New Sales Order Created

New-Proposal-Created ()

New Proposal Created

Order-Status-Changed (string Status)

Order Status Has Changed

Order-In-History ()

Order In History

Order-In-Processing ()

Order In Processing

Order-Is-Shipping ()

Order Is Shipping

Proposal-Needs-Approval ()

Proposal Needs Approval

WorkOrder-Closed ()

WorkOrder Closed

WorkOrder-Created ()

WorkOrder Created

WorkOrder-Past-Due ()

WorkOrder is Past Due

WorkOrder-Status-Changed (string Status)

WorkOrder Status Changed

 

Objects:

Name

Summary

Campaign_GetValueResponse

 

Campaign_PostValueParameterBody

 

Campaign_PostValueResponse

 

Campaign_PutValueParameterBody

 

Campaign_PutValueResponse

 

ComLog_GetValueResponse

 

ComLog_PostValueParameterBody

 

ComLog_PostValueResponse

 

ComLog_PutValueParameterBody

 

Contact_GetValueResponse

 

Contact_PostValueParameterBody

 

Contact_PostValueResponse

 

Contact_PutValueParameterBody

 

Contact_PutValueResponse

 

FollowUp_GetValueResponse

 

FollowUp_PostValueParameterBody

 

FollowUp_PostValueResponse

 

FollowUp_PutValueParameterBody

 

ItemList_GetValueResponse

 

ItemList_PostValueParameterBody

 

ItemList_PostValueResponse

 

ItemList_PutValueParameterBody

 

Lead_GetValueResponse

 

Lead_PostValueParameterBody

 

Lead_PostValueResponse

 

Lead_PutValueParameterBody

 

Lead_PutValueResponse

 

Members_GetValueResponse

 

Members_PostValueParameterBody

 

Members_PostValueResponse

 

Members_PutValueParameterBody

 

Members_PutValueResponse

 

New-Marketing-CampaignResponseItem

 

New-Members-LeadsResponseItem

 

New-Proposal-CreatedResponseItem

 

New-Sales-LeadResponseItem

 

New-Sales-OrderResponseItem

 

Order-In-HistoryResponseItem

 

Order-In-ProcessingResponseItem

 

Order-Is-ShippingResponseItem

 

Order-Status-ChangedResponseItem

 

Proposal-Needs-ApprovalResponseItem

 

Shipping_GetValueResponse

 

Shipping_PostValueParameterBody

 

Shipping_PostValueResponse

 

Shipping_PutValueParameterBody

 

SO_GetValueResponse

 

SO_PostValueParameterBody

 

SO_PostValueResponse

 

SO_PutValueParameterBody

 

WorkOrder-ClosedResponseItem

 

WorkOrder-CreatedResponseItem

 

WorkOrder-Past-DueResponseItem

 

WorkOrder-Status-ChangedResponseItem

 

WorkOrder_GetValueResponse

 

WorkOrder_PostValueParameterBody

 

WorkOrder_PostValueResponse

 

WorkOrder_PutValueParameterBody

 

 

Actions:

Campaign_GetValues

Summary: Get Campaign List

Description: Returns a list of campaigns

 

Syntax:

Imprezian360-CRM.Campaign_GetValues ()

 

Returns:

          Type:array of (string)

 

Campaign_PostValue

Summary: Create New Campaign

Description: Creates a new marketing campaign in the CRM

 

Syntax:

Imprezian360-CRM.Campaign_PostValue ([Optional]Campaign_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Campaign_PostValueParameterBody

 

 

False

 

Returns:

          Type:Campaign_PostValueResponse

 

Campaign_GetValue

Summary: Retrieve Campaign Details

Description: Retrieves the details of a specific campaign request by id

 

Syntax:

Imprezian360-CRM.Campaign_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Campaign ID)

Campaign ID

True

 

Returns:

          Type:Campaign_GetValueResponse

 

Campaign_PutValue

Summary: Update Campaign Data

Description: Updates a marketing campaign in the CRM

 

Syntax:

Imprezian360-CRM.Campaign_PutValue (string id, [Optional]Campaign_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Campaign ID)

Campaign ID

True

body

Campaign_PutValueParameterBody

 

 

False

 

Returns:

          Type:Campaign_PutValueResponse

 

ComLog_GetValues

Summary: Get ComLogs

Description: Returns a list of requested communication ID's

 

Syntax:

Imprezian360-CRM.ComLog_GetValues ()

 

Returns:

          Type:array of (string)

 

ComLog_PostValue

Summary: Create New ComLog

Description: New Communication Entry

 

Syntax:

Imprezian360-CRM.ComLog_PostValue ([Optional]ComLog_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ComLog_PostValueParameterBody

 

 

False

 

Returns:

          Type:ComLog_PostValueResponse

 

ComLog_GetValue

Summary: Retrieve ComLog Details

Description: Returns field details

 

Syntax:

Imprezian360-CRM.ComLog_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Communication ID)

Communication ID

True

 

Returns:

          Type:ComLog_GetValueResponse

 

ComLog_PutValue

Summary: Update Comlog Data

Description: Updates a communication entry

 

Syntax:

Imprezian360-CRM.ComLog_PutValue (string id, [Optional]ComLog_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Communication ID)

Communication ID

True

body

ComLog_PutValueParameterBody

 

 

False

 

Returns:

 

Contact_GetValues

Summary: Get Contact List

Description: retrieves a list of contacts

 

Syntax:

Imprezian360-CRM.Contact_GetValues ()

 

Returns:

          Type:array of (string)

 

Contact_PostValue

Summary: Create new CRM Contact

Description: Creates a qualified prospect, customer or vendor

 

Syntax:

Imprezian360-CRM.Contact_PostValue ([Optional]Contact_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Contact_PostValueParameterBody

 

 

False

 

Returns:

          Type:Contact_PostValueResponse

 

Contact_GetValue

Summary: Retrieve CRM Contact Details

Description: Retrieves details about the specified contact

 

Syntax:

Imprezian360-CRM.Contact_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Contact ID)

Contact ID

True

 

Returns:

          Type:Contact_GetValueResponse

 

Contact_PutValue

Summary: Update CRM Contact Data

Description: Update the specified CRM contact

 

Syntax:

Imprezian360-CRM.Contact_PutValue (string id, [Optional]Contact_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Contact ID)

Contact ID

True

body

Contact_PutValueParameterBody

 

 

False

 

Returns:

          Type:Contact_PutValueResponse

 

FollowUp_GetValues

Summary: Get FollowUp List

Description: Retrieve list of followups

 

Syntax:

Imprezian360-CRM.FollowUp_GetValues ()

 

Returns:

          Type:array of (string)

 

FollowUp_PostValue

Summary: Create New FollowUp

Description: Creates a new followup

 

Syntax:

Imprezian360-CRM.FollowUp_PostValue (FollowUp_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

FollowUp_PostValueParameterBody

 

 

True

 

Returns:

          Type:FollowUp_PostValueResponse

 

FollowUp_GetValue

Summary: Retrieve followup Details

Description: Followup details

 

Syntax:

Imprezian360-CRM.FollowUp_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Follow Up ID)

Follow Up ID

True

 

Returns:

          Type:FollowUp_GetValueResponse

 

FollowUp_PutValue

Summary: Update followup Data

Description: Updates a followup

 

Syntax:

Imprezian360-CRM.FollowUp_PutValue (string id, FollowUp_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Follow Up ID)

Follow Up ID

True

body

FollowUp_PutValueParameterBody

 

 

True

 

Returns:

 

ItemList_GetValues

Summary: Get Item List

Description: Returns a list of all items

 

Syntax:

Imprezian360-CRM.ItemList_GetValues ()

 

Returns:

          Type:array of (string)

 

ItemList_PostValue

Summary: Create New Item

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

 

Syntax:

Imprezian360-CRM.ItemList_PostValue ([Optional]ItemList_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

ItemList_PostValueParameterBody

 

 

False

 

Returns:

          Type:ItemList_PostValueResponse

 

ItemList_GetValue

Summary: Retrieve Item Details

Description: Details about a specific item

 

Syntax:

Imprezian360-CRM.ItemList_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Item Id)

Item id

True

 

Returns:

          Type:ItemList_GetValueResponse

 

ItemList_PutValue

Summary: Update Item Data

Description: Updates an existing item

 

Syntax:

Imprezian360-CRM.ItemList_PutValue (string id, [Optional]ItemList_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Item ID)

Item ID

True

body

ItemList_PutValueParameterBody

 

 

False

 

Returns:

 

Lead_GetValues

Summary: Get Active Leads

Description: Returns a list of active sales leads

 

Syntax:

Imprezian360-CRM.Lead_GetValues ()

 

Returns:

          Type:array of (string)

 

Lead_PostValue

Summary: Create New Lead

Description: Creates a new sales lead

 

Syntax:

Imprezian360-CRM.Lead_PostValue ([Optional]Lead_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Lead_PostValueParameterBody

 

 

False

 

Returns:

          Type:Lead_PostValueResponse

 

Lead_GetValue

Summary: Retrieve Lead Details

Description: retrieves the lead details

 

Syntax:

Imprezian360-CRM.Lead_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Lead ID)

Lead ID

True

 

Returns:

          Type:Lead_GetValueResponse

 

Lead_PutValue

Summary: Update Lead Data

Description: Update an existing sales lead

 

Syntax:

Imprezian360-CRM.Lead_PutValue (string id, Lead_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Lead ID)

Lead ID

True

body

Lead_PutValueParameterBody

 

 

True

 

Returns:

          Type:Lead_PutValueResponse

 

Members_GetValues

Summary: Get Member List

Description: Marketing campaign members

 

Syntax:

Imprezian360-CRM.Members_GetValues (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Supply L, C or B (required))Values: [C, L, B]

Type of campaign member (Lead, Contact or Both)

True

 

Returns:

          Type:array of (string)

 

Members_PostValue

Summary: Add New Member

Description: Adds a marketing campaign member

 

Syntax:

Imprezian360-CRM.Members_PostValue (Members_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Members_PostValueParameterBody

 

 

True

 

Returns:

          Type:Members_PostValueResponse

 

Members_GetValue

Summary: Retrieve Member Details

Description: retrieve details about a member

 

Syntax:

Imprezian360-CRM.Members_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Id of member)

Id of member

True

 

Returns:

          Type:Members_GetValueResponse

 

Members_PutValue

Summary: Remove Campaign Member

Description: Removes a marketing campaign member

 

Syntax:

Imprezian360-CRM.Members_PutValue (string id, Members_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Member ID)

Member ID

True

body

Members_PutValueParameterBody

 

 

True

 

Returns:

          Type:Members_PutValueResponse

 

Shipping_GetValues

Summary: Get Shipment List

Description: Returns a list of shipments

 

Syntax:

Imprezian360-CRM.Shipping_GetValues ()

 

Returns:

          Type:array of (string)

 

Shipping_PostValue

Summary: Create New Shipment

Description: Creates a shipment

 

Syntax:

Imprezian360-CRM.Shipping_PostValue (Shipping_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

Shipping_PostValueParameterBody

 

 

True

 

Returns:

          Type:Shipping_PostValueResponse

 

Shipping_GetValue

Summary: Retrieve Shipment Details

Description: get shipment details

 

Syntax:

Imprezian360-CRM.Shipping_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Order ID)

desired Order ID

True

 

Returns:

          Type:Shipping_GetValueResponse

 

Shipping_PutValue

Summary: Update Shipment Data

Description: Updates an existing shipment

 

Syntax:

Imprezian360-CRM.Shipping_PutValue (string id, [Optional]Shipping_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Shipment ID)

Shipment ID

True

body

Shipping_PutValueParameterBody

 

 

False

 

Returns:

 

SO_GetValues

Summary: Get Active Orders

Description: Returns a list of active orders

 

Syntax:

Imprezian360-CRM.SO_GetValues ()

 

Returns:

          Type:array of (string)

 

SO_PostValue

Summary: Create New Order

Description: Creates a new order

 

Syntax:

Imprezian360-CRM.SO_PostValue (SO_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

SO_PostValueParameterBody

 

 

True

 

Returns:

          Type:SO_PostValueResponse

 

SO_GetValue

Summary: Retrieve Order Details

Description: Retrieve details of an order

 

Syntax:

Imprezian360-CRM.SO_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(SalesOrder ID)

id of salesorder

True

 

Returns:

          Type:SO_GetValueResponse

 

SO_PutValue

Summary: Update Order Data

Description: Updates an existing order

 

Syntax:

Imprezian360-CRM.SO_PutValue (string id, SO_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Order ID)

Order ID

True

body

SO_PutValueParameterBody

 

 

True

 

Returns:

 

WorkOrder_GetValues

Summary: Get WorkOrder List

Description: List of workorders

 

Syntax:

Imprezian360-CRM.WorkOrder_GetValues ()

 

Returns:

          Type:array of (string)

 

WorkOrder_PostValue

Summary: Create New WorkOrder

Description: New Work-Order

 

Syntax:

Imprezian360-CRM.WorkOrder_PostValue (WorkOrder_PostValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

WorkOrder_PostValueParameterBody

 

 

True

 

Returns:

          Type:WorkOrder_PostValueResponse

 

WorkOrder_GetValue

Summary: Retrieve WorkOrder Details

Description: Returns details of a WO

 

Syntax:

Imprezian360-CRM.WorkOrder_GetValue (string id)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(Workorder ID)

id of workorder

True

 

Returns:

          Type:WorkOrder_GetValueResponse

 

WorkOrder_PutValue

Summary: Update WorkOrder Data

Description: Updates an existing WO

 

Syntax:

Imprezian360-CRM.WorkOrder_PutValue (string id, [Optional]WorkOrder_PutValueParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

id

string

(WorkOrder ID)

Workorder ID

True

body

WorkOrder_PutValueParameterBody

 

 

False

 

Returns:

 

Triggers:

Trigger New-Sales-Lead

Summary: New Sales Lead Created

Description: triggers when a new sales lead is created

 

Syntax:

Imprezian360-CRM.New-Sales-Lead ()

 

Returns:

          Type:array of (New-Sales-LeadResponseItem)

 

Trigger New-Marketing-Campaign

Summary: New Marketing Campaign Created

Description: triggers when a new marketing campaign is created

 

Syntax:

Imprezian360-CRM.New-Marketing-Campaign ()

 

Returns:

          Type:array of (New-Marketing-CampaignResponseItem)

 

Trigger New-Members-Leads

Summary: New Lead Campaign Members

Description: triggers when a lead has been added to a campaign

 

Syntax:

Imprezian360-CRM.New-Members-Leads (integer PromotionID)

 

Parameters:

Name

Type

Summary

Required

Related Action

PromotionID

integer(int32)

(Specify the campaign ID)

Campaign ID

True

 

Returns:

          Type:array of (New-Members-LeadsResponseItem)

 

Trigger New-Sales-Order

Summary: New Sales Order Created

Description: triggers when a new sales order is created

 

Syntax:

Imprezian360-CRM.New-Sales-Order ()

 

Returns:

          Type:array of (New-Sales-OrderResponseItem)

 

Trigger New-Proposal-Created

Summary: New Proposal Created

Description: triggers when a new proposal is created

 

Syntax:

Imprezian360-CRM.New-Proposal-Created ()

 

Returns:

          Type:array of (New-Proposal-CreatedResponseItem)

 

Trigger Order-Status-Changed

Summary: Order Status Has Changed

Description: triggers when the custom status of a quote or order changes

 

Syntax:

Imprezian360-CRM.Order-Status-Changed (string Status)

 

Parameters:

Name

Type

Summary

Required

Related Action

Status

string

(Enter the desired SO Status)

Status Text for Search

True

 

Returns:

          Type:array of (Order-Status-ChangedResponseItem)

 

Trigger Order-In-History

Summary: Order In History

Description: triggers when an order is complete and in history

 

Syntax:

Imprezian360-CRM.Order-In-History ()

 

Returns:

          Type:array of (Order-In-HistoryResponseItem)

 

Trigger Order-In-Processing

Summary: Order In Processing

Description: triggers when an order enters the processing phase

 

Syntax:

Imprezian360-CRM.Order-In-Processing ()

 

Returns:

          Type:array of (Order-In-ProcessingResponseItem)

 

Trigger Order-Is-Shipping

Summary: Order Is Shipping

Description: triggers when an order enters the shipping phase

 

Syntax:

Imprezian360-CRM.Order-Is-Shipping ()

 

Returns:

          Type:array of (Order-Is-ShippingResponseItem)

 

Trigger Proposal-Needs-Approval

Summary: Proposal Needs Approval

Description: triggers when a proposal enters the approval phase

 

Syntax:

Imprezian360-CRM.Proposal-Needs-Approval ()

 

Returns:

          Type:array of (Proposal-Needs-ApprovalResponseItem)

 

Trigger WorkOrder-Closed

Summary: WorkOrder Closed

Description: triggers when a workorder is closed

 

Syntax:

Imprezian360-CRM.WorkOrder-Closed ()

 

Returns:

          Type:array of (WorkOrder-ClosedResponseItem)

 

Trigger WorkOrder-Created

Summary: WorkOrder Created

Description: triggers when a workorder is created

 

Syntax:

Imprezian360-CRM.WorkOrder-Created ()

 

Returns:

          Type:array of (WorkOrder-CreatedResponseItem)

 

Trigger WorkOrder-Past-Due

Summary: WorkOrder is Past Due

Description: triggers when a workorder is past the due date

 

Syntax:

Imprezian360-CRM.WorkOrder-Past-Due ()

 

Returns:

          Type:array of (WorkOrder-Past-DueResponseItem)

 

Trigger WorkOrder-Status-Changed

Summary: WorkOrder Status Changed

Description: triggers when the status of the workorder has changed

 

Syntax:

Imprezian360-CRM.WorkOrder-Status-Changed (string Status)

 

Parameters:

Name

Type

Summary

Required

Related Action

Status

string

(The desired WO Status)

Enter WO Status Text

True

 

Returns:

          Type:array of (WorkOrder-Status-ChangedResponseItem)

 


 

Campaign_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

PromoID

string

 

PromoID

Campaign Manager

string

 

Campaign Manager

IS INACTIVE

string

 

IS INACTIVE

IN HISTORY

string

 

IN HISTORY

Used For Discounting

string

 

Used For Discounting

Used For Mail Broadcasting

string

 

Used For Mail Broadcasting

budget

string

 

budget

Promotion Type

string

 

Promotion Type

description

string

 

description

Employee Name

string

 

Employee Name

Start Date

string

 

Start Date

Expiration Date

string

 

Expiration Date

Revenue

string

 

Revenue


 

Campaign_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

A description of the campaign

startdate

string(date)

 

The start date of the campaign

expires

string(date)

 

Date the campaign expires

budget

number(float)

 

The total budget for the campaign

promotype

string

 

The type or category of the campaign (such as Google Search)

manager

string

 

The employee who manages the campaign


 

Campaign_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Campaign_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

string

 

Updated description for the campaign

startdate

string

 

What is the campaign start date

expires

string

 

Updated expiration for the campaign

budget

number(float)

 

Updated budget for the campaign

manager

string

 

Which employee manages the campaign

history

boolean

 

Is the campaign in history


 

Campaign_PutValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ComLog_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Direction

string

 

Direction

account

string

 

account

Account Name

string

 

Account Name

Contact Name

string

 

Contact Name

Start Date

string

 

Start Date

End Date

string

 

End Date

Employee Name

string

 

Employee Name

Type

string

 

Type

Length

string

 

Length

Subject

string

 

Subject

Content

string

 

Content

Billed

string

 

Billed

Work Order

string

 

Work Order

Sales Order

string

 

Sales Order

Sales Lead

string

 

Sales Lead

Project ID

string

 

Project ID

Recipient

string

 

Recipient

cc

string

 

cc

Bcc

string

 

Bcc

CallNumber

string

 

CallNumber

RecordID

string

 

RecordID

Company Name

string

 

Company Name


 

ComLog_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

contactid

string

 

The contact ID of the communication (blank for lead)

leadid

string

 

The Lead ID of the communication (zero for contact based)

type

string

 

E-Mail, Phone-call, etc  Values: [E-mail, Phone-Call, Fax, Tweet, Facebook, Other]

subject

string

 

Subject of communication

body

string

 

body

employee

string

 

CRM Employee name who performed action

starttime

string

 

starttime

endtime

string

 

endtime

workorder

string

 

Work order number of communication

project

string

 

Project linked to communication

campaign

string

 

The marketing campaign linked to the communication

length

number

 

length

billed

boolean

 

Has the communication entry been billed by the CRM

inbound

boolean

 

Is communication inbound (false = outbound)


 

ComLog_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ComLog_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

The type of the event  Values: [E-mail, Phone-Call, Fax, Tweet, Facebook, Other]

subject

string

 

The subject of the event

body

string

 

The message content

employee

string

 

The employee name that performed the action

starttime

string

 

The event start date/time

endtime

string

 

The end time of the communication

workorder

string

 

The work order number linked to the event

project

string

 

The project ID of the communication

campaign

string

 

The ID of the linked campaign

length

number

 

How long the event took place

billed

boolean

 

Has entry been invoiced in the CRM

inbound

boolean

 

Was the communication inbound


 

Contact_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Contact_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account

sal

string

 

sal

firstname

string

 

firstname

middlename

string

 

middlename

title

string

 

title

lastname

string

 

lastname

company

string

 

company

addr1

string

 

addr1

addr2

string

 

addr2

city

string

 

city

state

string

 

state

postal

string

 

postal

email1

string

 

email1

email2

string

 

email2

email3

string

 

email3

email4

string

 

email4

phonetype1

string

 

phonetype1

phone1

string

 

phone1

phonetype2

string

 

phonetype2

phone2

string

 

phone2

phonetype3

string

 

phonetype3

phone3

string

 

phone3

phonetype4

string

 

phonetype4

phone4

string

 

phone4

remark

string

 

remark

notes

string

 

notes

campaign

string

 

campaign

category

string

 

category

market

string

 

market

territory

string

 

territory

salesrep

string

 

salesrep

lastcontact

string(date-time)

 

lastcontact


 

Contact_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Contact_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

sal

string

 

sal

firstname

string

 

firstname

middlename

string

 

middlename

title

string

 

title

lastname

string

 

lastname

company

string

 

company

addr1

string

 

addr1

addr2

string

 

addr2

city

string

 

city

state

string

 

state

postal

string

 

postal

email1

string

 

email1

email2

string

 

email2

email3

string

 

email3

email4

string

 

email4

phonetype1

string

 

phonetype1

phone1

string

 

phone1

phonetype2

string

 

phonetype2

phone2

string

 

phone2

phonetype3

string

 

phonetype3

phone3

string

 

phone3

phonetype4

string

 

phonetype4

phone4

string

 

phone4

remark

string

 

remark

notes

string

 

notes

campaign

string

 

campaign

category

string

 

category

market

string

 

market

territory

string

 

territory

salesrep

string

 

salesrep

lastcontact

string(date-time)

 

lastcontact


 

Contact_PutValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FollowUp_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

account

string

 

account

RecallID

string

 

RecallID

Employee Name

string

 

Employee Name

SET FOR

string

 

SET FOR

SET BY

string

 

SET BY

SET ON

string

 

SET ON

IS CLEARED

string

 

IS CLEARED

Cleared By

string

 

Cleared By

Cleared On

string

 

Cleared On

ACCOUNT TYPE

string

 

ACCOUNT TYPE

Priority

string

 

Priority

TYPE

string

 

TYPE

Details

string

 

Details

Account Name

string

 

Account Name

First Name

string

 

First Name

Last Name

string

 

Last Name

Company Name

string

 

Company Name

FollowUp Date

string

 

FollowUp Date

Reminder Time

string

 

Reminder Time

WORK ORDER

string

 

WORK ORDER

Sales Lead

string

 

Sales Lead

Project ID

string

 

Project ID


 

FollowUp_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

contactid

string

 

The contact ID linked to the followup (blank for lead)

leadid

string

 

The lead ID of the followup (0 for contact)

type

string

 

The type of the follow up (Call Back, GoToMeeting, etc)

comments

string

 

Comments or Instructions related to the followup

assignedto

string

 

The employee name assigned to the followup

setby

string

 

The employee name that set the followup

duedate

string

 

The due date of the followup

urgent

boolean

 

Is this followup urgent

reminderminutes

number

 

Number of minutes before event for reminder (0 = none)

cleared

boolean

 

Is this followup Cleared


 

FollowUp_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FollowUp_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

The type of the followup (call back, gotomeeting, etc)

comments

string

 

Comments or Instructions related to followup

assignedto

string

 

Employee name assigned to followup

setby

string

 

Name of employee who set the followup

duedate

string

 

Due date of followup

urgent

string

 

Is this followup Urgent

reminderminutes

number

 

Reminder minutes of followup (0=none)

cleared

boolean

 

Is this followup cleared


 

ItemList_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Code

string

 

Code

Model Number

string

 

Model Number

Description

string

 

Description

Sales Description

string

 

Sales Description

Purchase Description

string

 

Purchase Description

Item Type

string

 

Item Type

Base Price

string

 

Base Price

Avg Cost

string

 

Avg Cost

Primary Category

string

 

Primary Category

Category2

string

 

Category2

Category3

string

 

Category3

Category4

string

 

Category4

Category5

string

 

Category5

Base UOM

string

 

Base UOM

Sell UOM

string

 

Sell UOM

Buy UOM

string

 

Buy UOM

Base Warehouse

string

 

Base Warehouse

On Hand

string

 

On Hand

On SO

string

 

On SO

Bad

string

 

Bad

On WO

string

 

On WO

On PO

string

 

On PO

Available

string

 

Available

Taxable

string

 

Taxable

Tax 2

string

 

Tax 2

Pays Commission

string

 

Pays Commission

Fixed Price

string

 

Fixed Price

Discounting Prohibited

string

 

Discounting Prohibited

Call For Price

string

 

Call For Price

Call For Cost

string

 

Call For Cost

Gratis Item

string

 

Gratis Item

Hidden on Printouts

string

 

Hidden on Printouts

Exclude From Margin

string

 

Exclude From Margin

Track Serial Numbers

string

 

Track Serial Numbers

Serialization Mode

string

 

Serialization Mode

Serial Number Required

string

 

Serial Number Required

Prohibit Duplicate Serial Numbers

string

 

Prohibit Duplicate Serial Numbers

Expiration Date Applies

string

 

Expiration Date Applies

Shipping Charges Apply

string

 

Shipping Charges Apply

Item must ship seperately

string

 

Item must ship seperately

Group Ship Items

string

 

Group Ship Items

Drop-Ship From Vendor

string

 

Drop-Ship From Vendor

Height

string

 

Height

Width

string

 

Width

Depth

string

 

Depth

Weight

string

 

Weight

Box Limit

string

 

Box Limit

Lead Time

string

 

Lead Time

Last Cost

string

 

Last Cost

Reorder Point

string

 

Reorder Point

Item Message

string

 

Item Message

ON SALE

string

 

ON SALE

IS ASSEMBLY

string

 

IS ASSEMBLY

Manufacturer Part Number

string

 

Manufacturer Part Number

OEM

string

 

OEM

BIN Location

string

 

BIN Location

Primary Vendor

string

 

Primary Vendor

Vendor 1 Part #

string

 

Vendor 1 Part #

Vendor 1 Descrip

string

 

Vendor 1 Descrip

Vendor 1 Cost

string

 

Vendor 1 Cost

Vendor 1 Date Cost Verified

string

 

Vendor 1 Date Cost Verified

Vendor 2

string

 

Vendor 2

Vendor 2 Part #

string

 

Vendor 2 Part #

Vendor 2 Descrip

string

 

Vendor 2 Descrip

Vendor 2 Cost

string

 

Vendor 2 Cost

Vendor 2 Date Cost Verified

string

 

Vendor 2 Date Cost Verified

Vendor 3

string

 

Vendor 3

Vendor 3 Part #

string

 

Vendor 3 Part #

Vendor 3 Descrip

string

 

Vendor 3 Descrip

Vendor 3 Cost

string

 

Vendor 3 Cost

Vendor 3 Date Cost Verified

string

 

Vendor 3 Date Cost Verified

Vendor 4

string

 

Vendor 4

Vendor 4 Part #

string

 

Vendor 4 Part #

Vendor 4 Descrip

string

 

Vendor 4 Descrip

Vendor 4 Cost

string

 

Vendor 4 Cost

Vendor 4 Date Cost Verified

string

 

Vendor 4 Date Cost Verified

Vendor 5

string

 

Vendor 5

Vendor 5 Part #

string

 

Vendor 5 Part #

Vendor 5 Descrip

string

 

Vendor 5 Descrip

Vendor 5 Cost

string

 

Vendor 5 Cost

Vendor 5 Date Cost Verified

string

 

Vendor 5 Date Cost Verified

Price Level Mode

string

 

Price Level Mode

Price Level 2

string

 

Price Level 2

Price Level 3

string

 

Price Level 3

Price Level 4

string

 

Price Level 4

Price Level 5

string

 

Price Level 5

Price Level 6

string

 

Price Level 6

Price Level 7

string

 

Price Level 7

Price Level 8

string

 

Price Level 8

Price Level 9

string

 

Price Level 9

Price Level 10

string

 

Price Level 10

Price Level 11

string

 

Price Level 11

Price Level 12

string

 

Price Level 12

Price Level 13

string

 

Price Level 13

Price Level 14

string

 

Price Level 14

Price Level 15

string

 

Price Level 15

Price Level 16

string

 

Price Level 16

Price Level 17

string

 

Price Level 17

Price Level 18

string

 

Price Level 18

Price Level 19

string

 

Price Level 19

Price Level 20

string

 

Price Level 20

Quantity Level 1

string

 

Quantity Level 1

Quantity Price 1

string

 

Quantity Price 1

Quantity Price Level 1

string

 

Quantity Price Level 1

Quantity Level 2

string

 

Quantity Level 2

Quantity Price 2

string

 

Quantity Price 2

Quantity Price Level 2

string

 

Quantity Price Level 2

Quantity Level 3

string

 

Quantity Level 3

Quantity Price 3

string

 

Quantity Price 3

Quantity Price Level 3

string

 

Quantity Price Level 3

Quantity Level 4

string

 

Quantity Level 4

Quantity Price 4

string

 

Quantity Price 4

Quantity Price Level 4

string

 

Quantity Price Level 4

Quantity Level 5

string

 

Quantity Level 5

Quantity Price 5

string

 

Quantity Price 5

Quantity Price Level 5

string

 

Quantity Price Level 5

Quantity Level 6

string

 

Quantity Level 6

Quantity Price 6

string

 

Quantity Price 6

Quantity Price Level 6

string

 

Quantity Price Level 6

Quantity Level 7

string

 

Quantity Level 7

Quantity Price 7

string

 

Quantity Price 7

Quantity Price Level 7

string

 

Quantity Price Level 7

Quantity Level 8

string

 

Quantity Level 8

Quantity Price 8

string

 

Quantity Price 8

Quantity Price Level 8

string

 

Quantity Price Level 8

Quantity Level 9

string

 

Quantity Level 9

Quantity Price 9

string

 

Quantity Price 9

Quantity Price Level 9

string

 

Quantity Price Level 9

Quantity Level 10

string

 

Quantity Level 10

Quantity Price 10

string

 

Quantity Price 10

Quantity Price Level 10

string

 

Quantity Price Level 10


 

ItemList_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

modelno

string

 

The part number, Model Number or SKU of the item

descrip

string

 

Sales description of item

itemtype

string

 

The type of the item (Inventory,NonInv,Misc,Discount,Service)  Values: [I, N, M, D, S]

price

number

 

The sales price of the item

cost

number

 

Last and Average cost of item

vendor

string

 

The vendor name purchased from


 

ItemList_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

New Code ID

New Code ID


 

ItemList_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

descrip

string

 

The updated description for the item

price

number

 

The updated price for the item

cost

number

 

The updated average and last cost of the item

vendor

string

 

The updated vendor for the item


 

Lead_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

type

string

 

type

leadid

string

 

leadid

Category

string

 

Category

recordid

string

 

recordid

Company Name

string

 

Company Name

Salutation

string

 

Salutation

First Name

string

 

First Name

Last Name

string

 

Last Name

Address Line 1

string

 

Address Line 1

Address Line 2

string

 

Address Line 2

City

string

 

City

State

string

 

State

Postal Code

string

 

Postal Code

Country

string

 

Country

Time-Zone

string

 

Time-Zone

Latitude

string

 

Latitude

Longitude

string

 

Longitude

Title

string

 

Title

Contact Type

string

 

Contact Type

Sales Rep

string

 

Sales Rep

Phone Extension

string

 

Phone Extension

Last Contact Date

string

 

Last Contact Date

Contact Notes

string

 

Contact Notes

Quick Remark

string

 

Quick Remark

Created Date

string

 

Created Date

Market

string

 

Market

Sales Territory

string

 

Sales Territory

Primary Email

string

 

Primary Email

EMail 2

string

 

EMail 2

Email 3

string

 

Email 3

Email 4

string

 

Email 4

OPTOUT

string

 

OPTOUT

Phone1

string

 

Phone1

Phone2

string

 

Phone2

Phone3

string

 

Phone3

Phone4

string

 

Phone4

Promotion Memberships

string

 

Promotion Memberships

Source

string

 

Source

Source Notes

string

 

Source Notes

Website

string

 

Website

Twitter

string

 

Twitter

Facebook

string

 

Facebook

LinkedIn

string

 

LinkedIn

Product Interest

string

 

Product Interest

Assigned To Rep

string

 

Assigned To Rep


 

Lead_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

sal

string

 

Mr, Ms, etc

firstname

string

 

First Name

middlename

string

 

Optional

title

string

 

Owner, VP, etc

lastname

string

 

Last Name

company

string

 

Optional

addr1

string

 

Address Line 1

addr2

string

 

Optional

city

string

 

Address City

state

string

 

State or Region

postal

string

 

Zip Code or Postal Code

email1

string

 

Email 1

email2

string

 

Email 2

email3

string

 

Email 3

email4

string

 

EMail 4

phonetype1

string

 

Home, Work, Cell, etc

phone1

string

 

(xxx) xxx-xxxx

phonetype2

string

 

Work, Cell, Fax, etc

phone2

string

 

Phone 2

phonetype3

string

 

Work, Cell, Fax, etc

phone3

string

 

Phone 3

phonetype4

string

 

Work, Cell, Fax, Ettc

phone4

string

 

Phone 4

remark

string

 

A short remark

notes

string

 

General Notes

campaign

string

 

The name (not the ID) of the marketing source

category

string

 

Category for the lead (such as Hot Lead, etc)

role

string

 

Decision maker, etc

market

string

 

Description of market (Industrial, Bakeries, etc)

territory

string

 

East, North, etc

salesrep

string

 

The sales rep name (blank for unassigned)

lastcontact

string

 

date of last contact


 

Lead_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Lead_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

sal

string

 

Mr, Ms, Etc

firstname

string

 

First Name

middlename

string

 

optional

title

string

 

VP, Owner, Janitor, etcf

lastname

string

 

Required

company

string

 

Optional

addr1

string

 

Address Line 1

addr2

string

 

Address Line 2

city

string

 

Address City

state

string

 

State or Region

postal

string

 

Zip or postal code

email1

string

 

Email 1

email2

string

 

Alternate Email

email3

string

 

Alternate EMail

email4

string

 

Alternate EMail

phonetype1

string

 

Cell, Fax, etc

phone1

string

 

(xxx) xxx-xxxx

phonetype2

string

 

Cell, Fax, etc

phone2

string

 

alternate phone

phonetype3

string

 

Cell, Fax, etc

phone3

string

 

alternate phone

phonetype4

string

 

Cell, fax, etc

phone4

string

 

alternate phone

remark

string

 

A short remark

notes

string

 

General notes

campaign

string

 

Description (not ID) of the marketing campaign

category

string

 

Hot Lead, etc

role

string

 

Decision Maker, etc

market

string

 

Description of market (Bakeries, Chemical Factory, etc)

territory

string

 

North, South, etc

salesrep

string

 

Blank for unassigned

lastcontact

string

 

date of last communication


 

Lead_PutValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Members_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

recordid

string

 

Record ID (numeric for lead, alpha for contact)

title

string

 

Mr, Ms, etc

fname

string

 

First name

lname

string

 

Last Name

addr1

string

 

Address Line 1

addr2

string

 

Address Line 2

city

string

 

Address City

state

string

 

State or Province

zipcode

string

 

Zip or Postal Code

email

string

 

Email

email2

string

 

Email 2

email3

string

 

Email 3

email4

string

 

Email 4

phone1

string

 

Phone 1

phone2

string

 

Phone 2

phone3

string

 

Phone 3

phone4

string

 

Phone 4


 

Members_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

promoid

string

 

The ID of the campaign to link to

recordtype

string

 

L for Lead, C for Contact  Values: [C, L]

recordid

string

 

Contact ID or Lead ID tied to campaign


 

Members_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Members_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

operation

string

 

only Remove supported at this time  Values: [remove]

recordtype

string

 

L for Lead, C for contact  Values: [L, C]

promoid

string

 

ID of campaign

recordid

string

 

Numeric id of lead or alphanumeric id of contact


 

Members_PutValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

New-Marketing-CampaignResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

promoid

string

 

the Id of the returned promotion


 

New-Members-LeadsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

lead id

string

 

The returned lead id from the request


 

New-Proposal-CreatedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Quote ID

string

 

The quote Id of the request


 

New-Sales-LeadResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

lead id

string

 

The lead id returned from the request


 

New-Sales-OrderResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

Order ID


 

Order-In-HistoryResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

the order id of the request


 

Order-In-ProcessingResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

the order id of the request


 

Order-Is-ShippingResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

the order id of the request


 

Order-Status-ChangedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

the order id of the request


 

Proposal-Needs-ApprovalResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Quote ID

string

 

the proposal id of the request


 

Shipping_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Customer

string

 

Customer

Order ID

string

 

Order ID

Model Number

string

 

Model Number

Descrip

string

 

Descrip

Shipped Qty

string

 

Shipped Qty

BoxID

string

 

BoxID

Tracking

string

 

Tracking

Ship Date

string

 

Ship Date

Shipped By

string

 

Shipped By

SerialData

string

 

SerialData

Ship_Company

string

 

Ship_Company

Ship_Contact

string

 

Ship_Contact

Ship_Addr1

string

 

Ship_Addr1

Ship_Addr2

string

 

Ship_Addr2

Ship_City

string

 

Ship_City

Ship_State

string

 

Ship_State

Ship_ZipCode

string

 

Ship_ZipCode

Ship_Phone

string

 

Ship_Phone

Carrier

string

 

Carrier

ShipmentID

string

 

ShipmentID

ItemID

string

 

ItemID


 

Shipping_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

orderid

string

 

ID of order to ship

shipdate

string

 

Date of shipment

carrier

string

 

UPS, Fedex, etc

method

string

 

Ground, Next Day Air, etc

weight

number

 

Weight of shipment

packagetype

string

 

Other, Box, Envelope, etc

reference1

string

 

PO Number, etc

reference2

string

 

BOL, etc

trackingnumber

string

 

Carrier Tracking Number

trackingurl

string

 

URL to track shipment

shippingcost

number

 

Cost of shipment

tohistory

boolean

 

Is this order complete?


 

Shipping_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

Shipping_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

shipdate

string

 

date of shipment

carrier

string

 

UPS, Fedex, etc

method

string

 

Ground, Next Day Air, etc

weight

number

 

weight of shipment

packagetype

string

 

Box, Envelope, etc

reference1

string

 

PO Number,etc

reference2

string

 

BOL number, etc

trackingnumber

string

 

Carrier Tracking Number

trackingurl

string

 

Carrier Tracking URL

shippingcost

number

 

cost of shipment


 

SO_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Order ID

string

 

Order ID

PROCESSING PHASE

string

 

PROCESSING PHASE

Account

string

 

Account

Account Name

string

 

Account Name

Sales Rep

string

 

Sales Rep

Custom Status

string

 

Custom Status

Description

string

 

Description

Quotation Date

string

 

Quotation Date

Close Date

string

 

Close Date

Ship Date

string

 

Ship Date

Expiration Date

string

 

Expiration Date

Terms

string

 

Terms

Marketing Campaign

string

 

Marketing Campaign

Shipping Warehouse

string

 

Shipping Warehouse

FOB

string

 

FOB

Deposit Required

string

 

Deposit Required

Total Weight

string

 

Total Weight

Quote Amount

string

 

Quote Amount

Partial Shipments OK

string

 

Partial Shipments OK

Invoice Shipping

string

 

Invoice Shipping

IN HISTORY

string

 

IN HISTORY

IS INACTIVE

string

 

IS INACTIVE

In-Pipeline

string

 

In-Pipeline

Tax 1

string

 

Tax 1

Tax 2

string

 

Tax 2

Is Template

string

 

Is Template

Template Name

string

 

Template Name

Customer PO

string

 

Customer PO

Ship To Company

string

 

Ship To Company

Ship To Contact

string

 

Ship To Contact

Ship To Addr 1

string

 

Ship To Addr 1

Ship To Addr 2

string

 

Ship To Addr 2

Ship To State

string

 

Ship To State

Ship To Postal Code

string

 

Ship To Postal Code

Ship To Country

string

 

Ship To Country

Ship To Phone

string

 

Ship To Phone

Ship To EMail

string

 

Ship To EMail

Residential

string

 

Residential

Formatted Ship To

string

 

Formatted Ship To

Paid Amount

string

 

Paid Amount

Balance Due

string

 

Balance Due

QB Invoice Number

string

 

QB Invoice Number

Confirmed Order

string

 

Confirmed Order

Commission

string

 

Commission

TotalCost

string

 

TotalCost

Margin

string

 

Margin

Project ID

string

 

Project ID

Next Appointment

string

 

Next Appointment

Appointment With

string

 

Appointment With

linedata:

array of (Linedata:Item)

 

linedata:

 

Linedata:Item

Summary:

Description:

 

          Properties:

Name

Type

Summary

itemid

string

 

itemid

orderqty

string

 

orderqty

uom

string

 

uom

modelno

string

 

modelno

descrip

string

 

descrip

comments

string

 

comments

shippedqty

string

 

shippedqty

price

string

 

price

subttl

string

 

subttl

total

string

 

total

 


 

SO_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

orderid

string

 

External Order ID

orderdate

string

 

Date of Order

orderdescription

string

 

External Order Description

account

string

 

Account number of customer (blank for new account)

accountname

string

 

Name of customer (becomes QB account name)

salesrep

string

 

Name of sales rep (blank for none)

firstname

string

 

Contact First Name

lastname

string

 

Contact Last Name

billemail

string

 

Email address of billing contact

billaddr1

string

 

Address line 1

billaddr2

string

 

Address Line 2

billcity

string

 

City or Region

billstate

string

 

State or province

billzipcode

string

 

zip or postal code

billcountry

string

 

Name of Country (United States, Canada, etc)

billphone

string

 

phone number of billing contact

billfax

string

 

Fax number of billing contact

shipcompany

string

 

Company Name

shipcontact

string

 

Attention Contact

shipaddr1

string

 

Address line 1

shipaddr2

string

 

Address Line 2

shipcity

string

 

Shipping City or Region

shipstate

string

 

State or Region

shipzipcode

string

 

Zip or Postal code

shipcountry

string

 

United States, Canada, etc

shipphone

string

 

shipping phone number

shipemail

string

 

Shipping EMail address

orderstatus

string

 

Primary status of incoming order  Values: [quote, confirmed, shipping, history]

customstatus

string

 

In Fulfillment, Pending Review, etc

taxdistrict

string

 

CA, FL, etc

taxrate

number(float)

 

Applied tax rate

campaign

string

 

Where order originated from (Google Search, etc)

ordertax

string

 

Total tax of order

shippingcost

string

 

Shipping cost billed on cart

shippingmethod

string

 

Preferred shipping method (UPS, etc)

couponamount

number

 

amount of coupon

couponcode

string

 

Black Friday Sale, etc

paymentmethod

string

 

Visa, MC, etc

comments

string

 

comments related to order

linedata

array of (LinedataItem)

 

linedata

 

LinedataItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

qty

number

 

Line Item Qty

modelno

string

 

SKU of line item

description

string

 

Description of line item

comments

string

 

Item Related Comments

price

number(double)

 

Line Item Price

discount

string

 

Discount of line item (positive value)

 


 

SO_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SO_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

comments

string

 

appends order comments

customstatus

string

 

Pending Review, Confirmed, etc

orderstatus

string

 

quote,confirmed,shipping,history  Values: [quote, confirmed, shipping, history]


 

WorkOrder-ClosedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Work Order Number

string

 

Work Order Number


 

WorkOrder-CreatedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Work Order Number

string

 

Work Order Number


 

WorkOrder-Past-DueResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Work Order Number

string

 

Work Order Number


 

WorkOrder-Status-ChangedResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

Work Order Number

string

 

Work Order Number


 

WorkOrder_GetValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

Work Order Number

string

 

Work Order Number

IN HISTORY

string

 

IN HISTORY

INACTIVE

string

 

INACTIVE

Priority

string

 

Priority

account

string

 

account

Customer Name

string

 

Customer Name

summary

string

 

summary

Content

string

 

Content

Assigned To

string

 

Assigned To

Backup Assignment

string

 

Backup Assignment

Received Date

string

 

Received Date

Due By

string

 

Due By

Opened-By

string

 

Opened-By

CONTRACT ID

string

 

CONTRACT ID

Source

string

 

Source

Custom Status

string

 

Custom Status

Reason Code

string

 

Reason Code

Customer Reference Number

string

 

Customer Reference Number

Service-To Company

string

 

Service-To Company

Service-To Contact

string

 

Service-To Contact

Service-To Address Line 1

string

 

Service-To Address Line 1

Service-To Address Line 2

string

 

Service-To Address Line 2

Service-To City

string

 

Service-To City

Service-To State

string

 

Service-To State

Service-To Postal Code

string

 

Service-To Postal Code

Service-To Phone

string

 

Service-To Phone

Service-To Country

string

 

Service-To Country

Service-To County

string

 

Service-To County

Latitude

string

 

Latitude

Longitude

string

 

Longitude

Time-Zone

string

 

Time-Zone

Formatted Service Address

string

 

Formatted Service Address

Created Date

string

 

Created Date

Customer Email

string

 

Customer Email

Customer PO

string

 

Customer PO

Service Appointment

string

 

Service Appointment

Project ID

string

 

Project ID

Total Charge

string

 

Total Charge

Time Spent

string

 

Time Spent


 

WorkOrder_PostValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

fromaddress

string

 

Email address of customer requesting work order

firstname

string

 

First Name

lastname

string

 

Last Name

companyname

string

 

Company Name

billaddr1

string

 

Address line 1

billaddr2

string

 

Address Line 2

billcity

string

 

Bill city

billstate

string

 

Billing state or region

billzipcode

string

 

Bill zip or postal

billcountry

string

 

United States, Canada, etc

billphone

string

 

billing phone number

billfax

string

 

Bill fax number

serviceaddr1

string

 

address to perform service

serviceaddr2

string

 

address to perform service

servicecity

string

 

address to perform service

servicestate

string

 

address to perform service

servicezipcode

string

 

zip or postal code

servicecountry

string

 

address to perform service

servicephone

string

 

(xxx) xxx-xxxx

receiveddate

string

 

date time workorder was received

ponumber

string

 

Customer PO Number

status

string

 

Open,Pending Review, etc

reasoncode

string

 

Customer Request,Warranty,etc

source

string

 

EMail, web, phone call etc

assignedto

string

 

blank for unassigned

backup

string

 

blank for unassigned

priority

string

 

Work Order Priority (0 Urgent = 4 Low)  Values: [0, 1, 2, 3, 4]

duedate

string

 

Work order due by date

subject

string

 

Brief summary of request

body

string

 

Descriptive text of Work Order


 

WorkOrder_PostValueResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

WorkOrder_PutValueParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

ponumber

string

 

Customer PO Number

status

string

 

Custom status (Work In Progress,etc)

reasoncode

string

 

Reason for request

source

string

 

Email,Phone,Web, etc

assignedto

string

 

The employee name the WO is assigned to

backup

string

 

The employee name of the backup technician

priority

string

 

0(Critical) to 4-(Low)  Values: [0, 1, 2, 3, 4]

duedate

string

 

due by date

subject

string

 

A brief summary of the request

body

string

 

The body of the request

history

boolean

 

places workorder in history