Veetro Web Service Methods
The following operations are supported. For a formal definition, please review the Service Description.
-
AddConversationFlagsWebSafe
Sets Flags for a conversation. -
AddEntityFlag
[Permission: Employee]
Adds the specified flags to the provided EntityID. Returns true if the operation succeeded, false if the EntityID doesn't exist. -
AddEntityFlagWebSafe
Adds the specified flags to the provided EntityID. Returns true if the operation succeeded, false if the EntityID doesn't exist or invalid flags were used. -
AddEntryFlag
[Permission: Employee]
Adds the specified flags to the provided EntryID. Returns true if the operation succeeded, false if the EntryID doesn't exist. -
AppendConversationMemberWebSafe
Adds a person to a conversation. Results in empty message being sent to all existing members. -
AssignSupportCases
[Permission: Employee]
Assigns support cases to the specified owner and sends an e-mail notification if OrganizationSupportSendNotifications is enabled. -
AuthenticateWebSafe
Attempts to authenticate a user, and begins a webservice session. (Note: This method will return a SessionKey, you must pass back a 'VeetroSession:' header for all future webservice requests. SessionKey's are valid for 24 hours from the time of last webservice/website hit.) -
BatchMoveAllNumbers
Moves all Street address numbers into a Billing address if present. -
CheckVeetroSession
Attempts to validate your VeetroSession key -
CountSupportStaffOnlineWebSafe
Returns the number of currently active staff who are available to handle support. -
CreateConversationWebSafe
Creates a Conversation. EntityHashID is the Person initializing the conversation. If the EntityHashID is an Employee Entity, the Conversation.Owner will be set to that Employee; otherwise, it'll be set as the Conversation.Relation -
CreateEntryFromCatalogItem
[Permission: Employee]
Creates a billable Entry from a CatalogItem in the specified Qty. -
CreateInvoice
[Permission: Employee]
Returns an committed invoice based on a collection of QuoteItems. -
DeleteCustomFieldData
Purges all custom field data having the specified field name. -
DeleteFolder
[Permission: Employee, Files] Deletes a folder, including all child folders. If documents are present and deleteContents = false, they will be moved into a /Orphans folder. Otherwise they will be deleted. -
DeleteMessage
[Permission: Any Authenticated - Creator or EmployeeManager]
Deletes a message. -
DownloadMessageOriginal
[Permission: Employee]
Return a single message -
EmailIsDuplicate
Returns the EntityID of a Person if the there is a different person in the Database which contains the same e-mail address as the one provided, otherwise returns 0. (This uses Person.EntityID and Entity.Email to locate a duplicate Entity.) -
EmailIsDuplicateWebSafe
Returns the EntityHashID of a Person having the specified email address. -
EnsureFolder
[Permission: Employee, Files] Ensures that the specified path exists, returns the existing folder or newly created one -
EntityAddTag
Applies a Tag or EntityFlag to an Entity -
EntityRemoveTag
Removes a Tag or EntityFlag from an Entity -
EntryAddTag
Applies a Tag or EntryFlag to an Entry -
EntryRemoveTag
Removes a Tag or EntryFlag from an Entry - ExportAddressBookCSV
- ExportAddressBookXLS
- ExportAllExcel
- ExportCatalogCSV
- ExportCustomViewCSV
-
ExportEmailFile
[Permission: Employee]
Downloads a *.eml file for the specified MessageID. Message must be 'MessageType.Email'. -
ExportLetters
Generates HTML content for printing/mass mail merge on the provided Template/Campaign of type 'Letter' -
ExportMailingListContactsCsv
Generates HTML content for printing/mass mail merge on the provided Template/Campaign of type 'Letter' -
ExportQuickBooksIIFAll
[Permission: Employee, Credentials: Finances]
Exports all invoices in QuickBooks *.IIF format. -
ExportQuickBooksIIFByDate
[Permission: Employee, Credentials: Finances]
Exports invoices in QuickBooks *.IIF format within a specific period. -
FindAny
[deprecated] Searches entire system based on keywords. This method is slow as it is a SQL Server search. Please use the Lucene-based 'Search' method instead. -
FindArticlesWebSafe
[Permission: Anonymous]
Returns an array of articles (basic fields only; Title, ArticleID, etc) belonging to the specified parent. If you want all root articles, set ArticleID_Parent to 0. -
FindCompanies
[Obsolete - use GetEntitySearchResults instead] Returns all Companies in the system with matching keywords. Searches Name and EntityID -
FindDocuments
Returns documents based on query provided -
FindEvents
Returns calendar events based on keywords -
FindInvoices
[Permission: Employee/Relation]
Returns Invoices based on keywords -
FindOrCreateActivity
Attempts to resolve an Activity by ActivityID, then by Name. If it doesn't exist, a new one will be created. -
FindOrCreateEntity
[Permission: Employee]
Attempts to return an Entity by EntityID, or name. Failing that, it will create a new Person entity. -
FindOrCreateProject
[Permission: Employee]
Attempts to locate a project under a specific client based on either EntryID or project Name -
FindOrCreateSupportCaseType
Attempts to resolve a SupportCaseType by SupportCaseTypeID, then by Name. If it doesn't exist, a new one will be created. -
FindPeople
[Obsolete - use GetEntitySearchResults instead] Returns all People in the system with matching keywords. Searches First Name, Surname, Email, Mobile and EntityID -
FindProjects
[Permission: Any Authenticated]
Returns projects based on keywords. If authenticated user is not Employee, only matching Relation's projects are returned which have the Client_Access flag. -
FindSupportCases
Returns all SupportCases in the system with matching keywords. Searches Name and Relation -
GetAccount
[Permission: Employee, Credentials: Finances]
Returns a full Account object. -
GetAccountBalance
[Permission: Employee, Credentials: Finances]
Returns calculated balance of an Account -
GetAccounts
[Permission: Employee, Credentials: Finances, SalesPipeline]
Returns an array of configured Accounts. -
GetActiveConversations
Returns an array of all conversations in the last 24 hours -
GetActvities
[Permission: Employee] Returns all Activity names in the system -
GetActvitiesActiveOnly
[Permission: Employee] Returns only Active activities in the system. - GetAllCatalogBrands
-
GetAllCurrenciesWebSafe
[Permission: Anonymous]
Returns all Currencies supported by the system. -
GetAllEntities
Returns all entities in the system. -
GetAllEntitiesByFlag
[Obsolete - use GetEntitySearchResults instead] Returns all entities in the system having the specified EntityFlags. -
GetAllEntitiesByOwnerAndFlag
[Obsolete - use GetEntitySearchResults instead] Returns all Entities in the system that have had least one Entry created by the provided EntityID and having the specified EntityFlags. -
GetAllLeads
Returns all Leads in the system -
GetAllLeadsByOwner
Returns all Leads in the system -
GetAllMailingLists
Returns all MailingLists in the system (basic fields only) -
GetAllMessagesWebSafe
Returns all Messages for a conversation that have not yet been read. -
GetAllProposals
Returns all Proposals in the system having the specified ProposalStatus (basic fields only) -
GetAllProposalsByOwner
Returns all Proposals in the system having the specified ProposalStatus (basic fields only) -
GetArticle
[Permission: Employee/Anonymous (public articles only)]
Returns an entire Article -
GetArticles
[Permission: Employee]
Returns an array of all articles (basic fields only; Title, ArticleID, etc) belonging to the specified parent. If you want all root articles, set ArticleID_Parent to 0. -
GetArticlesWebSafe
[Permission: Anonymous]
Returns an array of all Public_Access articles (basic fields only; Title, ArticleID, etc) belonging to the specified parent. If you want all root articles, set ArticleID_Parent to 0. -
GetAvatar
Returns an avatar image in it's native format. -
GetBillableEntities
[Permission: Employee, Credentials: Finances]
Returns an array of all Entities who have uninvoiced/billable Entries. BillableEntity inherits from Entity and includes an additional BillableItems array and TotalAmountBillable property. -
GetBillableEntries
[Permission: Employee]
Returns an array of all uninvoiced Entries for the provided EntityID. -
GetBlog
Returns a blog -
GetBlogsAll
Returns all blogs -
GetBlogsByOwner
Returns blogs that the specified Entity has permission to modify -
GetCalendar
[Deprecated - see GetCalendarViewDataPaged] Returns an iCal Calendar object containing events of the specified CalendarID -
GetCalendarViewDataPaged
[Permission: Any Authenticated]
Returns search results of any Entry type, Invoice, Notation, Message or Document. For non-employee users, CalendarViewTypes are limited to Support_Case, Project, Document and Notation. -
GetCalendarViewDataPagedDateSummaries
[Permission: Any Authenticated]
Provides a list of CalendarViewData dates, Types, IDs and (optionally) names. This method may be useful for reducing bandwidth for client applications who need a smaller summary of results. For results which normally contain multiple RRulePeriod dates, these are flattened so that duplicate rows are returned, one for each RRule occurrence. -
GetCalendarViewDataUnreadItemsSummary
[permission: Any_Authenticated] Gets a groupped collection of new/unread items for the current user. -
GetCalendars
Returns an iCal Calendar object containing events of the specified CalendarID - GetCatalogItemCategory
- GetCatalogItemCategoryByName
-
GetCatalogItemSearchResults
[deprecated] Returns an array of all CatalogItems (basic details only.) -
GetCatalogItemSearchResults2
Returns a paginated result of CatalogItems. -
GetCompany
[Permission: Any Authenticated]
Returns the Company containing the provided EntityID. If fullDetails is False, Arrays/Collection attributes such as Branches will not be populated (fullDetails=False is suitable for listings where in-depth data is not required.) Non-employee users cannot access contact details other than their own.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID, Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference. -
GetConflictsCount
[Permission: Employee]
Returns a number of sync conflicts the employee has. -
GetConversationMembersWebSafe
Returns an array of all Person members in a conversation. -
GetConversationsByUserWithUnreadMessages
Returns an array of all conversations in the last 24 hours -
GetCountriesWebSafe
Returns a list of recognised countries -
GetCustomFields
Returns an array of all Custom Fields that can be applied to Entities. -
GetCustomFields2
Returns an array of all Custom Fields that can be applied to the specified object type. - GetDBHistoryInfo
-
GetDisbursementEntry
[Permission: Employee]
Returns full details on a disbursement -
GetDocument
Returns documents based on query provided -
GetDocumentInfo
Returns documents based on query provided -
GetDocumentsByFolder
[Permission: Employee] Returns information on documents assigned to a folder. -
GetDocumentsByLead
[Permission: Employee] Returns information on documents assigned to a lead. -
GetEmployee
Returns an employee -
GetEmployeesActive
Returns only Active Employee's in the Database. -
GetEmployeesAll
Returns all Employee's in the Database. -
GetEntity
Returns a root Entity object for the specified EntityID (good for determining if an EntityID belongs to a Company or Person.) -
GetEntityByCustomField
[Permission: Employee]
Returns the first Entity (basic details only) having the specified CustomField name/value key pair. This is useful when you have a CustomField of type 'Hidden', used to sync to a 3rd party. -
GetEntityByEmail
[Permission: Employee]
Returns a root Entity object for the specified Name -
GetEntityByName
Returns a root Entity object for the specified Name -
GetEntityByNameAndFlag
Returns a root Entity object for the specified Name and flag -
GetEntityCount
Returns a record count for a set of contacts based on keywords and flags. -
GetEntitySearchResults
[Permission: Contacts] [deprecated] Returns a paged set of contacts. This is the preferred method for fetching contacts from your system. Valid EntitySortColumns are 'email', 'entityid' or 'name'. Set NameOnly to True for best performance. -
GetEntitySearchResults2
[Permission: Contacts] Returns a paged set of contacts. This is the preferred method for fetching contacts from your system. Set NameOnly to True for best performance. -
GetEntityTags
Returns an array of configured entity tags -
GetEntryByCustomField
[Permission: Employee]
Returns the first Entry (basic details only) having the specified CustomField name/value key pair. This is useful when you have a CustomField of type 'Hidden', used to sync to a 3rd party. -
GetEntryCustomStages
[permission: Any Authenticated] Gets custom entry priorities or status options.
Please Note: Please use "Value" property to store and search. -
GetEntrySearchResults
[Permission: Any Authenticated] Returns paginated entry results across all types. -
GetEntrySearchResults2
[Permission: Any Authenticated] Returns paginated entry results across all types. -
GetEntrySearchResults3
[Permission: Any Authenticated] Returns paginated entry results across all types. -
GetEvent
[Permission: Employee, Calendar or Timesheets or Tasks]
Returns full details on an event -
GetEventByUid
[Permission: Employee]
Returns full details on an event -
GetExpensesDocument
Returns an expenses sheet based on query provided -
GetField
[Permission: Employee]
Returns a custom field. -
GetFolderTemplate
[Permission: Employee] Returns a Folder Template -
GetFolderTemplates
[Permission: Employee] Returns Folder Templates in the system. -
GetInvoice
[Permission: Employee/Relation, Finances, SalesPipeline]
Returns an Invoice or Quote -
GetInvoiceByCustomField
[Permission: Employee/Relation, Finances, SalesPipeline]
Returns the first Invoice or Quote (basic details only) having the specified CustomField name/value key pair. This is useful when you have a CustomField of type 'Hidden', used to sync to a 3rd party. -
GetInvoiceDocument
Returns documents based on query provided -
GetInvoiceEmailTemplate
Returns your default e-mail template for invoice e-mails -
GetInvoiceItemsByCommissionOwner
[Permission: Employee, Finances, Commission Entity]
Returns an Invoice -
GetInvoiceSearchResults
[Permission: Employee/Relation]
Returns invoice search results -
GetInvoicesByRelation
[Permission: Employee/Relation]
Returns a list of invoices for the specified relation -
GetInvoicesByRelation2
[Permission: Employee/Relation]
Returns a list of invoices for the specified relation -
GetLead
Returns a Lead -
GetLeadByCustomField
[Permission: Employee]
Returns the first Lead (basic details only) having the specified CustomField name/value key pair. This is useful when you have a CustomField of type 'Hidden', used to sync to a 3rd party. -
GetLeadSearchResults
[Permission: Sales.Leads.ViewFull, Sales.Leads.ViewLimited] Returns paginated leads -
GetLeadsByOwner
Returns Leads for the specified owner. -
GetLeadsByRelation
Returns Leads for the specified relation. -
GetMailingList
Returns Mailing List information a given ID -
GetMailingLists
Returns all mailing lists in the system (basic details only) -
GetMailingListsByRelation
Returns all MailingLists that an Entity is subscribed to -
GetMailingProgress
Returns progress information a given TemplateID -
GetMessage
[Permission: Employee]
Return a single message -
GetNotation
[Permission: Any Authenticated - Creator or Employee]
Return a single notation -
GetNotations
[Permission: Employee]
Returns notations on an event -
GetPDF
Returns documents based on query provided -
GetPerson
[Permission: Any Authenticated] Returns the Person containing the provided EntityID. If fullDetails is False, Arrays/Collection and non-essential attributes such as Addresses will not be populated (fullDetails=False is suitable for listings where in-depth data is not required.) Non-employee users cannot access contact details other than their own.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID, Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference. -
GetPersonAuthenticateWebSafe
Returns the Basic Person details for the provided Email and Password. -
GetPersonFullWebSafe
Returns the Basic Person details for the provided EntityHashID. -
GetPersonWebSafe
Returns the Basic Person details for the provided EntityHashID. Never returns private data such as addresses etc. -
GetProject
[Permission: Any Authenticated, Projects]
Returns full details on a Project. If authenticated user is not Employee, only matching Relation's projects are returned which have the Client_Access flag. -
GetProjectStageGroups
[permission: Any Authenticated] Gets configured project stage groups (also known as Project Types). -
GetProjectsByMember
[Permission: Employee]
Returns basic project details for all projects where provided EntityID is a Member. Pass 0 for all current projects. -
GetProjectsByRelation
[Permission: Any Authenticated]
Returns basic project details for all projects where provided EntityID is the Relation -
GetProjectsRootByMember
[Permission: Employee]
Returns basic project details for all projects where provided EntityID is a Member -
GetProposal
Returns a Proposal -
GetQuote
[Permission: Employee, Credentials: Finances]
Returns an un-committed invoice based on a collection of QuoteItems. If EntityHashID is provided, the quote will return cumulative date ranges on existing subscription items. -
GetQuotes
[Permission: Employee]
Returns an array of all Quotes. -
GetQuotesByLead
[Permission: Employee]
Returns an array of all Quotes for the specified LeadID. -
GetQuotesByRelation
[Permission: Employee/Relation]
Returns a list of quotes for the specified relation -
GetRecentBlogPosts
Returns the last 50 blog posts -
GetRecentConversations
Returns an array of all conversations in the last 24 hours -
GetReminders
[Permission: Any Authenticated]
Returns all Reminders for a given Entry/Person combo. -
GetReportDocument
[Permission: Employee, Credentials: Reporting]
Returns reports based on query provided -
GetRootNotation
[Permission: Employee]
Finds root discussion Notation for the specified child NotationID -
GetRootProject
[Permission: Employee]
Finds the root project given sub-phase/project EntryID -
GetSalesProcesses
[Permission: Any Authenticated] Returns all Sales Processes in the system.
Please Note: We don't store stage in database, lead stage is calculated according to ProbabilityPercent and SalesProcess the lead in. -
GetShipping
[Permission: Employee]
Returns a specific Shipping option. -
GetShippingOptions
[Permission: Employee]
Returns an array of configured Shipping Options. -
GetSubscriptionEntry
[Permission: Employee]
Returns full details on a Subscription entry -
GetSubscriptionsByMailingList
Returns Subscription list -
GetSupportCase
Returns a Support Case entry -
GetSupportCaseMessages
Returns an array of Support Case messages. -
GetSupportCaseNotations
Returns an array of Support Case Notations. -
GetSupportCaseTypes
Returns an array of all available Support Case Types -
GetSupportCasesByCompany
Returns an array of Support Case for the specified Company EntityID. -
GetSupportCasesByOwner
Returns an array of Support Case for the specified Employee EntityID. -
GetSupportCasesByRelation
Returns an array of Support Case for the specified Contact/Relation EntityID. -
GetSupportCasesUnassigned
Returns an array of Support Case without an Owner (TOP 50 only.) -
GetSystemSettings
[Permission: Employee]
Returns a set of allowed system settings -
GetTags
Returns an array of configured entity tags. This is obsolete, please use GetEntityTags -
GetTagsForAnyObject
Returns an array of configured tags -
GetTaxOptions
[Permission: Employee]
Returns an array of configured Tax Options. -
GetTemplateSysFieldsWebSafe
Returns Fields contained within a document/form Template -
GetTemplateWebSafe
Returns a document Template -
GetTemplates
Returns all document Templates (basic fields only) -
GetTransaction
[Permission: Employee, Credentials: Finances]
Returns a Transaction -
GetTransactionCategories
[Permission: Employee]
Returns a list of previously utilised Transaction Category names. -
GetTransactionsByAccount
[Permission: Employee, Credentials: Finances]
Returns all transactions in an Account -
GetTransactionsByInvoice
[Permission: Employee/Relation]
Returns all transactions for an Invoice -
GetTransactionsBySupplierEntry
[Permission: Employee/Relation]
Returns all transactions for a supplier's Entry -
GetTransactionsDocument
Returns a transaction records document based on query provided -
GetTranslation
[permission: Anonymous] Gets a translated language dictionary key for the current user's Language setting. -
GetTranslations
[permission: Anonymous] Gets translated language dictionary keys for the current user's Language setting. -
GetUnhandledSupportConversationCount
Returns the number of unhandled live support conversations. -
GetUnhandledSupportConversations
Returns an array of unhandled live support conversations. -
GetUnpaidExpensesAll
[Permission: Employee, Credentials: Finances]
Returns all unpaid expense entries. -
GetUnpaidInvoices
[Permission: Employee, Credentials: Finances]
Returns an array of all Invoices having an outstanding balance. -
GetUnreadMessagesWebSafe
Returns all Messages for a conversation that have not yet been read. -
GetUserBookmarks
[permission: Any_Authenticated] Returns a list of bookmarked items with a specified max number of each VeetroBaseType -
GetUserGroups
Returns all Employee UserGroup's in the Database. -
GetUserSetting
[permission: Any_Authenticated] Returns a setting for currently signed in user. -
GetViewHistory
[permission: Any_Authenticated] Returns a list of recently viewed items with a specified max number of each VeetroBaseType -
GetViewHistoryPaged
[permission: Any_Authenticated] Returns a paginated list of recently viewed items with an optional specified max number of each VeetroBaseType, VeetroBaseType type filter and/or ViewHistoryFlags. -
GetWorkgroup
[Permission: Employee]
Returns the Workgroup containing the provided EntityID. If fullDetails is False, Arrays/Collection attributes such as Members will not be populated (fullDetails=False is suitable for listings where in-depth data is not required.) - IntToEntityFlagsWebSafe
- IntToEntryFlags
- IntToEntryFlagsWebSafe
-
InvoiceAppendEntry
[Permission: Employee, Credentials: Finances]
Appends a Entry object to an invoice for billing -
InvoiceEmail
[Permission: Employee]
E-mails the specified Invoice as a PDF document to the recipient. -
InvoiceRemoveTag
Removes a Tag or InvoiceFlag from an Invoice -
LeadRemoveTag
Removes a Tag or LeadFlag from a Lead -
MarkAsReadWebSafe
Marks a message as read. -
MarkRead
Marks Entries and Notations as read. -
MarkRead2
[permission: Any_Authenticated] Updates the ViewHistory DateUtc for one or more object IDs for the authenticated user. -
MoveKBArticle
[Permission: Employee]
Returns an entire Article -
MoveMessage
[Permission: Employee] Moves an existing MessageID into the specified EntryID or LeadID. Specify null (not zero) if you do not wish to modify either the EntryID or LeadID. Specifying zero detaches the message. - On2CheckOutINS
- PerformAuthorizeNetPayment
- PollAutoEvents
- PollForAlerts
-
PollForSupportMail
Polls POP3 inbox for new Support Email -
PollMailer
Initiates mail-queue polling/sending - ProcessEmailClensing
-
RegenerateAllInvoiceCodes
[Permission: Employee, Credentials: Finances]
Regenerates every Invoice and Quote in the system to use the current Invoice Code format setting and StartNumbers. -
RemoveConversationFlagsWebSafe
Removes Flags for a conversation. -
RemoveEntityFlag
[Permission: Employee]
Adds the specified flags to the provided EntityID. Returns true if the operation succeeded, false if the EntityID doesn't exist. -
RemoveEntityFlagWebSafe
Adds the specified flags to the provided EntityID. Returns true if the operation succeeded, false if the EntityID doesn't exist or invalid flags were used. -
RemoveEntryFlag
[Permission: Employee]
Adds the specified flags to the provided EntryID. Returns true if the operation succeeded, false if the EntryID doesn't exist. -
RemoveInvoice
[Permission: Employee, Credentials: Finances or SalesPipeline]
Removes an invoice and rolls back Entry objects that were marked as Invoiced during it's original creation. -
RemoveNotation
Saves a Notation. If NotationID = 0, a new Notation will be created. Returns a Saved copy of the Notation including the newly created NotationID. -
RemoveSubscription
Removes a Subscription to a MailingList for the specified Entity. If a subscription does not exist, the method returns False, overwise True. -
RemoveSubscriptionWebSafe
Removes a Subscription to a MailingList for the specified Entity. If a subscription does not exist, the method returns False, overwise True. -
RemoveTransaction
[Permission: Employee, Credentials: Finances]
Saves a transaction and updates any applicable invoice balances. - RenewVeetroSession
- RestoreDeletedObject
- RestoreDeletedObjects
-
Search
Searches entire system based on keywords using an optimized Lucene index search engine. -
SendMessageWebSafe
Posts a message to the conversation. -
SendPasswordWebSafe
E-mails a matching user a password reset link. Returns True if the user exist, otherwise false. -
SetAccount
[Permission: Employee, Credentials: Finances]
Saves an Account. -
SetActivity
Saves an Activity, returns activity with the new UniqueID -
SetArticle
[Permission: Employee, KnowledgeBase]
Saves a KB Article -
SetAvatar
Saves an avatar image. -
SetBlog
Saves or Creates a Blog -
SetBlogPost
Saves or Creates a Blog Post -
SetCalendar
Saves a Calendar object. If CalendarID = 0, a new Calendar will be created. Returns a Saved copy of the Calendar including the newly created CalendarID. -
SetCatalogItem
Saves a CatalogItem. If CatalogItemID = 0, a new CatalogItem will be created. Returns a Saved copy of the CatalogItem including the newly created CatalogItemID. -
SetCatalogItemCategory
[Permission: Employee, Sales]
Saves a CatalogItemCategory or creates new if CatalogItemCategoryID is 0. -
SetCatalogItemPhoto
[Permission: Employee]
Saves a CatalogItemPhoto. If CatalogItemPhotoID = 0, a new CatalogItemPhoto will be created. Returns a Saved copy of the CatalogItemPhoto with the CatalogItemPhotoID only (does not return full image data.) -
SetCompany
[Permission: Any Authenticated]
Saves a Company. If EntityID = 0, a new Company will be created. Returns a Saved copy of the Company including the newly created EntityID. Non-employee users can only save their own profile and previous/existing settings are overridden upon save. New contact creation is also not permitted by non-employee users.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID, Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference. -
SetCustomFieldsWebSafe
Sets Custom field values for the specified EntityHashID. If Field.Name's match existing values, old values are overwritten, otherwise new Fields are added to the Entity. -
SetDisbursementEntry
[Permission: Employee]
Saves a billable disbursement entry -
SetDocument
Saves a Document. If DocumentID = 0, a new Document will be created. Returns a Saved copy of the Document including the newly created DocumentID. When saving a document, Guid does not need to be provided. DateModified will always be overwritten by service. -
SetDocumentInfo
Updates document information without affecting the binary data, or commits a previously uploaded 'todisk' Guid. If DocumentID is 0, Guid is required. You may use this method to commit a Guid which was previously uploaded to /UploadEx?Type=todisk&WorkerGuid={YOURGUID}, or simply modify document information without supplying the original binary. -
SetEmployee
Saves an Employee. If EntityID = 0, a new Employee will be created. Returns a Saved copy of the Employee including the newly created EntityID. -
SetEvent
[Permission: Employee, Calendar or Timesheets or Tasks] Saves a Calendar Event. If EntryID = 0, a new Entry will be created. Returns a Saved copy of the Event including the newly created EntryID. -
SetField
[Permission: Employee]
Saves a custom field. Specifying IsSysField as true and a SysFieldType denotes that the field is a Template for use on the appropriate editor. -
SetFolder
Saves a Folder. If FolderID = 0, a new Folder will be created. Returns a Saved copy of the Folder including the newly created FolderID. -
SetFolderTemplate
Saves a folder template, and updates any Folders which use the template. -
SetFolderTemplateLink
[Permission: Employee] Saves a FolderTemplateLink and creates folders based on the FolderTemplate. -
SetInvoice
[Permission: Employee, Finances, SalesPipeline]
Saves an Invoice or Quote. If InvoiceID = 0, a new Invoice will be created. Returns a Saved copy of the Invoice including the newly created InvoiceID. (Note: InvoiceCode should be NULL. The system will generate an Invoice Code for you based on your configuration. Also you cannot change an InvoiceCode on existing Invoices.)
All Entity / Address field data is ignored by this web method. Please specify only existing EntityID and AddressID values for your Relation, BillTo, ShipTo, etc. See SetPerson or SetCompany to create new customer contacts, or GetEntityByEmail to find an existing contact. If GetEntityByEmail is successful, you then use GetPerson (or GetCompany if Entity.Flags contains Company), to obtain AddressID's suitable for use in the BillTo/ShipTo Address objects. -
SetLead
Saves a Lead. If LeadID = 0, a new Lead will be created. Returns a Saved copy of the Lead including the newly created LeadID. -
SetLeadProbabilityPercent
Set the ProbabilityPercent attribute on a Lead -
SetMailingList
[Permission: Employee, EmailMarketing] Saves a MailingList. If MailingListID = 0, a new MailingList will be created. Returns a Saved copy of the MailingList including the newly created MailingListID. -
SetMailingListsSubscriptions
Creates Subscriptions to a MailingList for the specified Entity. Any MailingListIDs NOT specified will result in subscription removals for the Entity. Returns True when added successfully. -
SetMessageMIME
[Permission: Employee] Saves a MIME email message and returns the basic details of the parsed Message object. If the MIME's Rfc822 MessageID is already in the database, the existing Message details will be returned and no import will take place. Specify EntryID or LeadID to override the default message attachment behaviour. -
SetNotation
[Permission: Employee]
Saves a Notation. If NotationID = 0, a new Notation will be created. Returns a Saved copy of the Notation including the newly created NotationID. -
SetPerson
[Permission: Any Authenticated]
Saves a Person. If EntityID = 0, a new Person will be created. Returns a Saved copy of the Person including the newly created EntityID. Non-employee users can only save their own profile and previous/existing settings are overridden upon save. New contact creation is also not permitted by non-employee users.
Please Note: The auto-generated SOAP examples do not include inherited properties such as EntityID, Email, etc. Use a proper WSDL framework to generate XML or see GetEntity for XML node reference. -
SetPersonWebSafe
Saves a Person. If EntityHashID is Empty, a new Person will be created. Returns a Saved copy of the Person including the newly created EntityHashID. -
SetProductEntry
[Permission: Employee]
Saves a billable product entry -
SetProject
[Permission: Employee]
Saves a Project. If EntryID = 0, a new Entry will be created. Returns a Saved copy of the Project including the newly created EntryID. -
SetProposalWebSafe
Saves a Proposal. If ProposalID = 0, a new Proposal will be created. Returns a Saved copy of the Proposal including the newly created ProposalID. -
SetReminder
[Permission: Any Authenticated]
Saves a reminder. -
SetShipping
[Permission: Employee]
Creates or updates a Shipping option. -
SetSubjectWebSafe
Sets the Subject for a conversation. -
SetSubscription
Creates a Subscription to a MailingList for the specified Entity. If a subscription already exists, no duplication will occur, however the method will return False. Returns True when added successfully. -
SetSubscriptionEntry
[Permission: Employee]
Saves a billable subscription entry -
SetSubscriptionWebSafe
Creates a Subscription to a MailingList for the specified Entity. If a subscription already exists, no duplication will occur, however the method will return False. Returns True when added successfully. -
SetSupportCase
Saves a Support Case. Message is optional - when provided, the message will be appended to the Support Case. -
SetSupportCaseMessage
Saves a Message to a Support Case. EntryID must be that of a valid Support Case. Sends message to customer if Message.Owner is an employee, otherwise a notification is sent to the Employee Case owner if notifications are configured. -
SetSupportCaseNotation
Saves a Notation to a Support Case. -
SetSupportCaseType
Saves a Support Case Type definition -
SetTax
[Permission: Employee, Credentials: Finances]
Saves or creates a Tax option. -
SetTemplate
Saves a Template. If TemplateID = 0, a new Template will be created. Returns a Saved copy of the Template including the newly created TemplateID. -
SetTransaction
[Permission: Employee, Credentials: Finances, SalesPipeline]
Saves a transaction and updates any applicable invoice balances. -
SetUserBookmark
[permission: Any_Authenticated] Updates an item's bookmarked status -
SetUserGroup
[Permission: Contacts.Employees.ModifyFull] Creates or updates a UserGroup -
SetUserSetting
[permission: Any Authenticated] Returns a setting for currently signed in user. -
SetWorkgroup
[Permission: Employee]
Saves a Workgroup. If Workgroup = 0, a new Workgroup will be created. Returns a Saved copy of the Workgroup including the newly created EntityID. -
StartMailing
[Permission: Employee, EmailMarketing] Enqueues recipients of a Template of type Email and initiates polling. -
StopMailing
[Permission: Employee] Suspends mailing of a template. - StringToAddress
-
SyncEntities
[Permission: Employee]
Adds each person to the database by trying to sync with existing by DateModified fields.
Returns an array of conflicts.
Maximum number of contacts that can be passed is 50. -
UserStartedTypingWebSafe
Set's a user's status to 'typing' -
UserStoppedTypingWebSafe
Removes a user's 'typing' status - _CleanUpDuplicateCustomFields
- _TestWebSafe