Veetro Web Service Methods
The following operations are supported. For a formal definition, please review the Service Description.
-
AddConversationFlagsWebSafe
[Permission: Anonymous]
Sets Flags for a conversation. -
AddDeclinedNotation
[Permission: Employee]
Declines a discussion request -
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
[Permission: Anonymous]
Adds the specified flags to the provided secure EntityID hash. Returns true if the operation succeeded, false if the EntityID doesn't exist or invalid flags were used. -
AddEntryFlag
[Permission: Any Authenticated]
Adds the specified flags to the provided EntryID. Returns true if the operation succeeded, false if the EntryID doesn't exist. -
AddLikedNotation
[Permission: Employee]
Applies a like to a discussion post -
AppendConversationMemberWebSafe
[Permission: Anonymous]
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
[Permission: Anonymous]
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
[Permission: Employee, Credentials: System.Administrator]
Utility method to moves all Street address numbers into a Billing address if present. -
BookmarkNotation
[Permission: Employee]
Bookmark a discussion post -
CheckPasswordStrength
[Permission: Any_Authentificated]
Calculates a strength indication for the specified text. -
CheckVeetroSession
[Permission: Any Authenticated]
Attempts to validate your VeetroSession key. -
CleanEntryHierarchies
[Permission: Employee]
Intended for support staff use only. -
CountSupportStaffOnlineWebSafe
[Permission: Anonymous]
Returns the number of currently active staff who are available to handle support. -
CreateConversationWebSafe
[Permission: Anonymous]
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 -
CreateDocumentWebSafe
[Permission: Anonymous]
Creates a Document. 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. This is for the admin site only. Use SetDocument for normal usage. -
CreateEntriesFromCatalogItems
[Permission: Employee, Credentials: Sales.Catalog.CreateProductSales]
Creates a batch billable Entries from CatalogItems having the specified Qty. -
CreateEntryFromCatalogItem
[Permission: Employee, Credentials: Sales.Catalog.CreateProductSales]
Creates a billable Entry from a CatalogItem having the specified Qty. -
CreateInvoice
[Permission: Employee, Credentials: Finances.Invoices.Create]
Returns a committed invoice based on a collection of QuoteItems. -
DeleteCustomFieldData
[Permission: Employee, Credentials: System.Administrator]
Purges all custom field data having the specified field name. -
DeleteFolder
[Permission: Employee, Credentials: Documents.Files.DeleteFull]
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]
Deletes a message. Only a Message.Owner or a System.Administrator may delete messages. -
DuplicateProject
[Permission: Employee, Credentials: Work.Projects.ViewFull]
Duplicate a project according to settings -
EmailIsDuplicate
[Permission: Employee]
Returns the EntityID of an Entity if the there is a different contact in the Database which contains the same e-mail address as the one provided, otherwise returns 0. (This uses Entity.EntityID and Entity.Email and Entity.AlternativeEmails to locate a duplicate Entity.) -
EmailsDuplicateWebSafe
[Permission: Anonymous]
Returns true if a Person having the specified email address. -
EnsureFolder
[Permission: Employee, Credentials: Documents.Files.Create]
Ensures that the specified path exists, returns the existing folder or newly created one -
EntityAddTag
[Permission: Employee, Credentials: Contacts.Employees/People/Companies/Workgroups ]
Applies a Tag or EntityFlag to an Entity -
EntityAddTags
[Permission: Employee, Credentials: Contacts.Employees/People/Companies/Workgroups ]
Applies Tags or EntityFlags to an Entity -
EntityRemoveTag
[Permission: Employee, Credentials: Contacts.Employees/People/Companies/Workgroups ]
Removes a Tag or EntityFlag from an Entity -
EntityRemoveTags
[Permission: Employee, Credentials: Contacts.Employees/People/Companies/Workgroups ]
Removes Tags or EntityFlags from an Entity -
EntryAddTag
[Permission: Employee]
Applies a Tag or EntryFlag to an Entry -
EntryRemoveTag
[Permission: Employee]
Removes a Tag or EntryFlag from an Entry -
ExportAddressBookCSV
[Permission: Employee, Credentials: Contacts.DirectoryExport]
Exports the address book in CSV format. -
ExportAddressBookXLS
[Permission: Employee, Credentials: Contacts.DirectoryExport]
Exports the address book in XLSX format. -
ExportAllExcel
[Permission: Employee, Credentials: System.Administrator]
Performs an XLSX export of all Entity, Person, Employee, Address, Invoice, Entry, Lead and related SQL tables. This method is provided as-is and unsupported. It is exists for the general convenience of small customer data sets where a full SQL Server backup download is not as practical.
Due to the Excel limit if there's more than 32767 characters in a cell we have to truncate the content. -
ExportCatalogCSV
[Permission: Employee]
Exports the product catalog in CSV format. -
ExportCustomViewCSV
[Permission: Employee, Credentials: Reporting.CustomViews]
Exports the specified CustomeView in CSV format. -
ExportCustomViewXLS
[Permission: Employee, Credentials: Reporting.CustomViews]
Exports the specified CustomeView in XLSX format. -
ExportEmailFile
[Permission: Employee]
Downloads a *.eml file for the specified MessageID. Message must be 'MessageType.Email'. -
ExportLetters
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Generates HTML content for printing/mass mail merge on the provided Template/Campaign of type 'Letter' -
ExportMailingListContactsCsv
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Generates HTML content for printing/mass mail merge on the provided Template/Campaign of type 'Letter' -
ExportQuickBooksIIFAll
[Permission: Employee, Credentials: Finances.InvoiceExport]
Exports all invoices in QuickBooks *.IIF format. -
ExportQuickBooksIIFByDate
[Permission: Employee, Credentials: Finances.InvoiceExport]
Exports invoices in QuickBooks *.IIF format within a specific period. -
FindAny
[Deprecated - see Search] -
FindArticlesWebSafe
[Permission: Anonymous]
Performs a keyword search on articles. For non-employee users only public articles will be returned. -
FindCompanies
[Deprecated - see GetEntitySearchResults2] -
FindDocuments
[Deprecated - see GetCalendarViewDataPaged] -
FindEvents
[Deprecated - see GetCalendarViewDataPaged] -
FindInvoices
[Deprecated - see GetInvoiceSearchResults] -
FindOrCreateActivity
[Permission: Employee]
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, Credentials: Work.Projects]
Attempts to locate a project under a specific client based on either EntryID or project Name -
FindOrCreateSupportCaseType
[Permission: Employee]
Attempts to resolve a SupportCaseType by SupportCaseTypeID, then by Name. If it doesn't exist, a new one will be created. -
FindPeople
[Deprecated - see GetEntitySearchResults2] -
FindProjects
[Permission: Any Authenticated, Credentials: Work.Projects.ViewFull/Limited]
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
[Permission: Any Authenticated]
Returns all SupportCases in the system with matching keywords. Searches Name and Relation -
FlagNotation
[Permission: Employee]
Applies flags to a discussion post -
FlagNotationRecipient
[Permission: Employee]
Applies flags to Discussion post recipients -
GetAccount
[Permission: Employee, Credentials: Finances]
Returns a full bank Account object. -
GetAccountBalance
[Permission: Employee, Credentials: Transactions.ViewFull]
Returns the calculated balance of a bank Account -
GetAccountPrefix
[Permission: Any Authenticated]
Get the Business Prefix used for email subject. -
GetAccounts
[Permission: Employee, Credentials: Finances, SalesPipeline]
Returns an array of all configured bank Accounts. -
GetActiveConversations
[Permission: Employee]
Returns an array of all conversations in the last 24 hours -
GetActvities
[Permission: Employee]
Returns all Activity names in the system -
GetActvitiesActiveOnly
[Permission: Any Authenticated]
Returns only Active activities in the system. -
GetAllCatalogBrands
[Permission: Any Authenticated]
Returns an array of brand names used by CatalogItems. -
GetAllCurrenciesWebSafe
[Permission: Anonymous]
Returns all Currencies supported by the system. -
GetAllEntities
[Deprecated - see GetEntitySearchResults2] -
GetAllEntitiesByFlag
[Deprecated - see GetEntitySearchResults2] -
GetAllEntitiesByOwnerAndFlag
[Deprecated - see GetEntitySearchResults2] -
GetAllLeads
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns all Leads in the system that are visible to the user. -
GetAllLeadsByOwner
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns all Leads in the system that are visible to the user and having the specified owner. -
GetAllMailingLists
[Permission: Employee]
Returns all MailingLists in the system (basic fields only) -
GetAllMessagesWebSafe
[Permission: Anonymous]
Returns all Messages for a conversation that have not yet been read. -
GetAllProposals
[Permission: Employee]
Returns all Proposals in the system having the specified ProposalStatus (basic fields only.) -
GetAllProposalsByOwner
[Permission: Employee]
Returns all Proposals in the system having the specified ProposalStatus (basic fields only.) -
GetAllTags
[Permission: Employee]
Get all tags or available tags for specified type, available types are FieldSysType.Entity, FieldSysType.ToDo, FieldSysType.Project, FieldSysType.Support_Case, FieldSysType.Journal, FieldSysType.Lead, FieldSysType.Event, FieldSysType.Product. If type is null, will get all tags for all types, otherwise if type is not null, will get all available tags(not Hide or Disabled) for specified type. -
GetArticle
[Permission: Employee/Anonymous (public articles only)]
Returns an entire Article -
GetArticles
[Permission: Employee, Credentials: Documents.KnowledgeBase.ViewFull/Limited]
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. -
GetArticlesPagedWebSafe
[Permission: Any Authenticated]
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, setArticleID_Parent = 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
[Permission: Anonymous]
Returns an avatar image in its native binary format. -
GetBillableEntities
[Permission: Employee, Credentials: Finances.UnbilledCharges]
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. By default up-coming subscription entries will not be returned until they come due within 48hrs. SpecifyallSubscriptions = true
to have all active future subscriptions returned as well. -
GetBillableEvents
[Permission: Employee]
Returns a paged set of billable entries(Event, Timesheet or Todo) -
GetBlog
[Permission: Employee, Credentials: Documents.Blogs.ViewFull/Limited]
Returns a blog website -
GetBlogPostCommentsPaged
[Permission: Employee, Credentials: Documents.Blogs.ViewFull/Limited]
Returns all BlogPostComments for the specified BlogPostID -
GetBlogPostsPaged
[Permission: Employee, Credentials: Documents.Blogs.ViewFull/Limited]
Returns all BlogPost basic details for the specified BlogID -
GetBlogsAll
[Permission: Employee, Credentials: Documents.Blogs.ViewFull/Limited]
Returns all blog websites -
GetBlogsByOwner
[Permission: Employee, Credentials: Documents.Blogs.ViewFull/Limited]
Returns blog websites which the specified Entity has permission to modify -
GetCalendar
[Deprecated - see GetCalendarViewDataPaged] -
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
[Permission: Employee]
Returns an iCal Calendar object containing events of the specified CalendarID -
GetCatalogItem
Get a Product or Subscription By Id -
GetCatalogItemCategory
[Permission: Any Authenticated]
Gets the specified CatalogItemCategory. -
GetCatalogItemCategoryByName
[Permission: Any Authenticated]
Gets the specified CatalogItemCategory by its name. -
GetCatalogItemCategorySearchResults
[Permission: Employee]
Returns the CatalogItemCategories. -
GetCatalogItemSearchResults
[Deprecated - see GetCatalogItemSearchResults2] -
GetCatalogItemSearchResults2
[Permission: Employee]
Returns a paginated result of CatalogItems. -
GetCoWorkersWebSafe
[Permission: Any_Authenticated]
Retrieves all the users of the company that the current user belongs to. -
GetCompanies
[Permission: Employee, Credentials: Contacts.Companies.ViewFull/Limited]
Returns the Companies containing the provided EntityIDs. 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. No more than 50 per batch. -
GetCompany
[Permission: Any Authenticated, Credentials: Contacts.Companies.ViewFull/Limited]
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. -
GetCompanySetting
[Permission: Employee]
Returns a setting for current company/organization. -
GetConflictsCount
[Permission: Employee, Credentials: Contacts.DirectorySync]
Returns a number of sync conflicts the employee has. -
GetConversationMembersWebSafe
[Permission: Anonymous]
Returns an array of all Person members in a conversation. -
GetConversationsByUserWithUnreadMessages
[Permission: Employee]
Returns an array of all conversations in the last 24 hours -
GetCountriesWebSafe
[Permission: Anonymous]
Returns a list of recognised countries -
GetCurrentCurrencySymbol
[Permission: Any Authenticated]
Returns the current Currency symbol used across the account. -
GetCurrentCustomerSecurityInfo
[Permission: Any Authenticated,
Returns customer security information like permissions -
GetCustomFields
[Deprecated - see GetCustomFields2] -
GetCustomFields2
[Permission: Anonymous]
Returns an array of all Custom Fields that can be applied to the specified object type. -
GetCustomerPortalActivities
[Permission: Any Authenticated]
Returns available Activities for certain customer - GetCustomerPortalSettings
-
GetCustomerPortalSettingsPublic
[Permission: Anonymous]
Gets customer portal configuration settings. -
GetDBHistoryInfo
[Permission: Employee]
A utility method intended for support staff. -
GetDisbursementEntries
[Permission: Employee, Credentials: Finances.Expenses.ViewFull/Limited]
Returns full details on the disbursement Entries. No more than 50 per batch. -
GetDisbursementEntry
[Permission: Employee, Credentials: Finances.Expenses.ViewFull/Limited]
Returns full details on a disbursement Entry -
GetDocument
[Permission: Anonymous]
Returns documents based on random GUID provided. -
GetDocumentInfo
[Permission: Anonymous]
Returns documents based on query provided -
GetDocumentSearchResults
[Permission: Employee, Credentials: Documents.Files.ViewFull/Limited]
Returns information on documents. -
GetDocumentsByFolder
[Permission: Employee, Credentials: Documents.Files.ViewFull/Limited]
Returns information on documents assigned to a folder. -
GetDocumentsByLead
[Permission: Employee, Credentials: Documents.Files.ViewFull/Limited]
Returns information on documents assigned to a lead. -
GetDraftTimesheets
[Permission: Any Authenticated,
Returns draft timesheets -
GetEmailSignature
[Permission: Employee]
Get the email signature of the current user in html format. -
GetEmployee
[Permissions: Employee, Credentials: Contacts.Employees.ViewFull/Limited]
Returns an employee -
GetEmployees
[Permissions: Employee, Credentials: Contacts.Employees.ViewFull]
Returns the employees with the provided EntityIDs. -
GetEmployeesActive
[Permissions: Employee]
Returns only Active Employees in the database (basic details.) -
GetEmployeesAll
[Permissions: Employee]
Returns all Employees in the database (basic details.) -
GetEntitiesByEmails
[Permission: Employee]
Attempts to return the Entities by emails. -
GetEntitiesByIDs
[Permission: Any Authenticated]
Returns root Entities for the specified EntityIDs. -
GetEntity
[Permission: Any_Authenticated]
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
[Permission: Employee]
Returns a root Entity object for the specified Name -
GetEntityByNameAndFlag
[Permission: Employee]
Returns a root Entity object for the specified Name and flag -
GetEntityCount
[Permission: Employee]
Returns a record count for a set of contacts based on keywords and flags. -
GetEntityIDnWebSafe
[Permission: Anonymous]
Returns the EntityID for the provided Email. -
GetEntitySearchResults
[Deprecated - see GetEntitySearchResults2] -
GetEntitySearchResults2
[Permission: Contacts, Credentials: Contacts.Directory]
Returns a paged set of contacts. This is the preferred method for fetching contacts from your system. Set NameOnly to True for best performance. -
GetEntitySearchResults2NoFiltersSimple
[Permission: Contacts, Credentials: Contacts.Directory]
Returns a set of simple contacts with special logic, include all employees and workgroups, also contain recent activity contacts. Only returns Name, Email, Flags & RelatedCompanies. -
GetEntitySearchResults2Simple
[Permission: Contacts, Credentials: Contacts.Directory]
Returns a paged set of simple contacts. Only returns Name, Email, Flags & RelatedCompanies. -
GetEntitySearchResults2SimpleUpdated
[Permission: Contacts, Credentials: Contacts.Directory]
Returns a list of simple contacts which were modified/deleted/created since last updated. Only returns Name, Email, Flags & RelatedCompanies. -
GetEntityShared
[Permission: NULL]
Returns a paged set of contacts shared with certain person, return contacts only contain EntityID, Name, Flags. -
GetEntityTags
[Permission: Employee]
Returns an array of configured entity tag names -
GetEntries
[Permission: Employee]
Gets an array of base Entry classes for the specified EntryIDs. -
GetEntry
[Permission: Any_Authenticated]
Gets an Entry classe for the specified EntryID. -
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. -
GetEntryByName
[Permission: Employee]
Gets the first entry having the specified name and flags. -
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
[Deprecated - see GetEntrySearchResults3] -
GetEntrySearchResults3
[Permission: Any Authenticated]
Returns paginated entry results across all types with simple data, EntryID is the only available sort column, but if keyword has value, it will sort by keyword rank first, then sort by EntryID. -
GetEntrySearchResultsDetailed
[Permission: Any Authenticated]
Returns paginated entry results with full data across all types, For faster results with less data, use GetEntrySearchResults3. -
GetEntrySearchResultsWithViewOrder
[Permission: Any Authenticated] Returns paginated entry results across all types and ordered by the order you viewed. -
GetEvent
[Permission: Any Authenticated, Calendar.Events or Work.Timesheets or Work.ToDos]
Returns full details on an Event -
GetEventByUid
[Permission: Employee]
Returns full details on an event -
GetEvents
[Permission: Employee, Calendar.Events or Work.Timesheets or Work.ToDos]
Returns full details on the given Events, no more than 50 per batch. -
GetExpensesDocument
[Permission: Employee, Credentials: Finances.ExpenseExport]
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. -
GetFolders
[Permission: Employee, Credentials: Permissions.Documents.Files.ViewFull/Limited]
Return Folders -
GetIndustrySearchResults
[Permission: Anonymous]
Returns a paged list of industry types. -
GetInvoice
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Returns full details on an Invoice or Quote -
GetInvoiceByCustomField
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
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
[Permission: Employee, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Exports an Invoice documents in the format specified. -
GetInvoiceEmailTemplate
[Permission: Employee]
Returns your default e-mail template for invoice e-mails -
GetInvoiceItemsByCommissionOwner
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited, Finances.Transactions]
Returns an array of InvoiceItems where the InvoiceItem.EntityID_Commission matches the specified Entity. This method is used for displaying Commission earnings by sales agents. -
GetInvoiceSearchResults
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Returns invoice search results -
GetInvoiceSearchResults2
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Returns invoice search results -
GetInvoices
[Permission: Employee, Credentials: Finances.Invoices.ViewFull/Limited, Sales.Quotes.ViewFull/Limited]
Returns full details on the given Invoices or Quotes, no more than 50 per batch. -
GetInvoicesByRelation
[Deprecated: see GetInvoicesByRelation2] -
GetInvoicesByRelation2
[Permission: Any Authenticated, Credentials: Finances.Invoices.ViewFull/Limited]
Returns a list of invoices for the specified relation -
GetLead
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
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. -
GetLeadPrefix
[Permission: Any Authenticated]
Get the Lead Prefix used for email subject. -
GetLeadSearchResults
[Deprecated - see GetLeadSearchResults2] -
GetLeadSearchResults2
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns paginated leads -
GetLeads
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns the given Leads, no more than 50 per batch -
GetLeadsByOwner
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns Leads for the specified owner. -
GetLeadsByRelation
[Permission: Employee, Credentials: Sales.Leads.ViewFull/Limited]
Returns Leads for the specified relation EntityID. -
GetLeadsPaged
Returns a paged resultset of Leads -
GetMailingList
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Returns Mailing List information a given ID -
GetMailingLists
[Permission: Employee]
Returns all mailing lists in the system (basic details only) -
GetMailingListsByRelation
[Permission: Any Authenticated]
Returns all MailingLists that an Entity is subscribed to -
GetMailingProgress
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Returns progress information a given TemplateID -
GetMessage
[Permission: Employee]
Returns a single message. -
GetMiscStatisticsData
[Permission: Employee, Credentials: Will be different according to the types data return]
Returns misc statistic data based on query provided, e.g. total of unbilled charges -
GetModifiedItems
[Permission: Employee, Credentials: Will be different according to the types data return]
Returns misc data that have been modified after a specific datetime. -
GetNotation
[Permission: Any Authenticated]
Returns a single notation -
GetNotationSearchResult
[Permission: Employee]
Returns Discussion Notations -
GetNotationThread
[Permission: Employee]
Returns a Discussion thread including child posts -
GetNotations
[Deprecated - see GetCalendarViewDataPaged] -
GetNoteSearchResult
[Permission: Employee]
Returns Notes -
GetOutlookContactLastModifiedDate
[Permission: Employee]
Get the last modified utc date of contact. Used for WORKetc outlook plugin only. -
GetOutlookSyncRecord
[Permission: Employee]
Get sync record by id. Used for WORKetc outlook plugin only. -
GetOutlookSyncRecordByEntityID
[Permission: Employee]
Search sync record by entityId. Used for WORKetc outlook plugin only. -
GetOutlookSyncRecordByRemoteID
[Permission: Employee]
Search sync record by remote Id. Used for WORKetc outlook plugin only. -
GetPDF
[Permission: Anonymous]
Performs a HTML to PDF conversion. -
GetPasswordSettingWebSafe
[Permission: Anonymous]
Returns a bollean value indicating if it's allowed to change password in customer portal. -
GetPerson
[Permission: Any Authenticated, Credentials: Contacts.People.ViewFull/Limited]
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
[Permission: Anonymous]
Returns the Basic Person details for the provided Email and Password. -
GetPersonFullWebSafe
[Permission: Anonymous]
Returns the Basic Person details for the provided EntityHashID. -
GetPersonWebSafe
[Permission: Anonymous]
Returns the Basic Person details for the provided EntityHashID. Never returns private data such as addresses etc. -
GetPersons
[Permission: Employee, Credentials: Contacts.People.ViewFull/Limited]
Returns the Persons containing the provided EntityIDs. 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. No more than 50 per batch. -
GetProductEntries
[Permission: Employee]
Returns full details on the Product entries. No more than 50 per batch. -
GetProject
[Permission: Any Authenticated, Credentials: Work.Projects.ViewFull/Limited]
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. -
GetProjectResultsByCustomView
[Permission: Any Authenticated, Credentials: Work.Projects.ViewFull/Limited]
Returns a paged set of full project details according to filters of smart list -
GetProjectStageGroups
[Permission: Any Authenticated]
Gets configured project stage groups (also known as Project Types.) -
GetProjects
[Permission: Employee, Credentials: Work.Projects.ViewFull/Limited]
Returns full details on the given Projects, no more than 50 per batch. -
GetProjectsByMember
[Permission: Employee, Credentials: Work.Projects.ViewFull/Limited]
Returns basic project details for all projects where provided EntityID is a Member. PassEntityID=0
for all current projects. -
GetProjectsByRelation
[Permission: Any Authenticated, Credentials: Work.Projects.ViewFull/Limited]
Returns basic project details for all projects where provided EntityID is the Relation -
GetProjectsRootByMember
[Permission: Employee, Credentials: Work.Projects.ViewFull/Limited]
Returns basic project details for all projects where provided EntityID is a Member -
GetProposal
[Permission: Employee]
Returns a Proposal document. Proposals describe web forms, letters etc which can be exported as PDFs. -
GetProposalSearchResults
[Permission: Employee]
Returns Proposals for the specified search criteria -
GetQuote
[Permission: Employee, Credentials: Sales.Quotes.Create]
Returns an un-committed invoice based on a collection of QuoteItems. If EntityHashID is provided, the quote will also append cumulative date ranges on existing subscription items. -
GetQuotes
[Permission: Employee, Credentials: Sales.Quotes.ViewFull/Limited]
Returns an array of all Quotes (basic details.) -
GetQuotesByLead
[Permission: Employee, Credentials: Sales.Quotes.ViewFull/Limited]
Returns an array of all Quotes for the specified LeadID. -
GetQuotesByRelation
[Permission: Any Authenticated, Credentials: Sales.Quotes.ViewFull/Limited]
Returns a list of quotes for the specified relation -
GetRecentBlogPosts
[Permission: Employee]
Returns the last 50 blog posts across all Blog websites. -
GetRecentConversations
[Permission: Employee]
Returns an array of all conversations in the last 24 hours -
GetReminders
[Permission: Any Authenticated]
Returns all Reminders for a given Entry/Entity combo. -
GetReportDocument
[Permission: Employee, Credentials: Reporting.Reports]
Returns reports based on query provided -
GetRootNotation
[Permission: Employee]
Finds root discussion Notation for the specified child NotationID -
GetRootProject
[Permission: Employee, Credentials: Work.Projects.ViewFull/Limited]
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. -
GetSubscriptionEntries
[Permission: Employee]
Returns full details on the Subscription entries. No more than 50 per batch. -
GetSubscriptionEntry
[Permission: Employee]
Returns full details on a Subscription entry -
GetSubscriptionsByMailingList
[Permission: Employee]
Returns a list of Subscriptions for the specified mailing list. -
GetSupportCase
[Permission: Any Authenticated, Credentials: Work.SupportCases.ViewFull/Limited]
Returns a SupportCase entry -
GetSupportCaseMessages
[Permission: Any Authenticated]
Returns an array of SupportCase messages. -
GetSupportCaseNotations
[Permission: Employee]
Returns an array of SupportCase Notations. -
GetSupportCaseTypes
[Permission: Any Authenticated]
Returns an array of all available SupportCase Types -
GetSupportCases
[Permission: Employee, Credentials: Work.SupportCases.ViewFull/Limited]
Returns the given SupportCases, no more than 50 per batch. -
GetSupportCasesByCompany
[Permission: Employee, Credentials: Work.SupportCases.ViewFull/Limited]
Returns an array of SupportCases for the specified Company EntityID, max value of top is 50. -
GetSupportCasesByOwner
[Permission: Employee, Credentials: Work.SupportCases.ViewFull/Limited]
(Deprecated - see GetSupportCasesSearchResults) Returns an array of SupportCases for the specified Employee EntityID, max value of top is 50. -
GetSupportCasesByRelation
[Permission: Any Authenticated, Credentials: Work.SupportCases.ViewFull/Limited]
(Deprecated - see GetSupportCasesSearchResults) Returns an array of SupportCases for the specified Contact/Relation EntityID, max value of top is 50. -
GetSupportCasesSearchResults
[Permission: Employee, Credentials: Work.SupportCases.ViewFull/Limited]
Returns paginated SupportCases, max value of FetchSize is 100. -
GetSupportCasesUnassigned
[Permission: Employee]
Returns an array of SupportCases without an Owner (TOP 50 only.) -
GetSystemSettings
[Permission: Any Authenticated]
Returns a set of allowed system settings. -
GetTags
[Deprecated: see GetEntityTags] -
GetTagsForAnyObject
[Permission: Employee]
Returns an array of configured tag names for the specified FieldSysType. -
GetTasksOfCustomer
[Permission: Any Authenticated(Exclude Company Account), Credentials: Work.ToDos.ViewFull/Limited]
Returns tasks that created by customer or assigned to customer, if customer have Company permisson, result also include tasks assigned to other people or created by other people in same company. (If the tasks attached to a Project, the project must be enable 'Client Access' option.) -
GetTaxOptions
[Permission: Employee]
Returns an array of configured Tax Options. -
GetTemplateSysFieldsWebSafe
[Permission: Anonymous]
Returns Fields contained within a document/form Template -
GetTemplateWebSafe
[Permission: Anonymous]
Returns a document Template -
GetTemplates
[Permission: Any Authenticated]
Returns all document Templates (basic fields only) of the specified type. -
GetTransaction
[Permission: Employee, Credentials: Finances.Transactions.ViewFull/Limited]
Returns a Transaction's full details. -
GetTransactionCategories
[Permission: Employee]
Returns a list of previously used Transaction Category names. This is a utility method for auto-complete purposes. -
GetTransactionsByAccount
[Permission: Employee, Credentials: Finances.Transactions.ViewFull/Limited]
Returns all transactions in an Account -
GetTransactionsByInvoice
[Permission: Any Authenticated, Credentials: Finances.Transactions.ViewFull/Limited]
Returns all transactions for an Invoice -
GetTransactionsBySupplierEntry
[Permission: Any Authenticated, Credentials: Finances.Transactions.ViewFull/Limited]
Returns all transactions for a supplier's Entry -
GetTransactionsDocument
[Permission: Employee, Credentials: Finances.TransactionExport]
Returns a transactions document in the Output specified for the provided search parameters. -
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
[Permission: Employee]
Returns the number of unhandled live support conversations. -
GetUnhandledSupportConversations
[Permission: Employee]
Returns an array of unhandled live support conversations. -
GetUnpaidExpensesAll
[Permission: Employee, Credentials: Finances.Expenses.ViewFull]
Returns all unpaid expense Entry items. -
GetUnpaidInvoices
[Permission: Employee, Credentials: Finances.Invoices.ViewFull/Limited]
Returns an array of all Invoices having an outstanding balance. -
GetUnreadMessagesWebSafe
[Permission: Anonymous]
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
[Permission: Employee]
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. -
GetWebFormsWebSafe
[Permission: Any Authenticated]
Gets Proposal document search results having Proposal.Type Form -
GetWorkgroup
[Permission: Employee, Credentials: Contacts.Workgroups.ViewFull/Limited]
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.) -
ImpersonateCustomer
[Permission: Employee]
Used by employees to create user sessions for impersonating customers. -
IntToEntityFlagsWebSafe
[Permission: Anonymous]
Used for SOAP/XML subscribers only. Converts the specified numeric bitwise flag value into named EntityFlags. JSON/javascript users may use the following definitions:
EntityFlags = { Sales_Lead: 1 << 1, Customer: 1 << 2, Supplier: 1 << 3, Subscriber: 1 << 4, Company: 1 << 5, Person: 1 << 6, Employee: 1 << 7, Do_Not_Email: 1 << 8, Inactive: 1 << 9, Enable_Entry_Alerts: 1 << 10, Disable_Login: 1 << 11, Email_Bounced: 1 << 12, Xero_Contact : 1 << 13, Workgroup : 1 << 14, Disable_Owner_Alerts : 1 << 15, QuickBooks_Contact:1<<16, }
-
IntToEntryFlags
[Deprecated - see IntToEntryFlagsWebSafe] -
IntToEntryFlagsWebSafe
[Permission: Anonymous]
Used for SOAP/XML subscribers only. Converts the specified numeric bitwise flag value into named EntryFlags. JSON/javascript users may use the following definitions:
EntryFlags = { None: 0, Billable: 1 << 0, Invoiced: 1 << 1, Journal: 1 << 2, Canceled: 1 << 3, Project: 1 << 4, Calendar_Item: 1 << 5, Event: 1 << 6, ToDo: 1 << 7, Support_Case: 1 << 8, Product: 1 << 9, Subscription: 1 << 10, Notifications_Sent: 1 << 11, Disbursement: 1 << 12, Client_Access: 1 << 13, QuoteOnly: 1 << 14, Track_Supplier_Payments: 1 << 15, All_Employees: 1 << 16, Project_Milestone: 1 << 17, Never_Invoice: 1 << 18, Inactive: 1 << 19, IsTemplate: 1 << 20, Pending: 1 << 21, IsGrouped: 1 << 22 }
-
InvoiceAppendEntry
[Permission: Employee, Credentials: Finances.Invoices.Create]
Appends a Entry object to an existing invoice for billing. -
InvoiceEmail
[Permission: Employee]
E-mails the specified Invoice as a PDF document to the recipient. -
InvoiceRemoveTag
[Permission: Employee]
Removes a Tag or InvoiceFlag from an Invoice -
LeadRemoveTag
[Permission: Employee]
Removes a Tag or LeadFlag from a Lead -
MarkAsReadWebSafe
[Permission: Anonymous]
Marks a message as read. -
MarkRead
[Deprecated - see MarkRead2] -
MarkRead2
[Permission: Any Authenticated]
Updates the ViewHistory DateUtc for one or more object IDs for the authenticated user. -
MergeContact
[Merge two contacts and will delete the source contact.] -
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. -
MoveNotation
[Permission: Employee]
Move a discussion post -
PollAutoEvents
This method is not intended to be called by user applications. -
PollForAlerts
This method is not intended to be called by user applications. -
PollForSupportMail
This method is not intended to be called by user applications. -
PollMailer
[Permission: Anonymous]
Initiates mail-queue polling/sending. This method is not intended to be called by user applications directly. -
ProcessEmailClensing
[Permission: Employee]
A utility method for processing Non Delivery Report data. -
RedirectNotation
[Permission: Employee]
Redirect a discussion request -
RedirectNotationChangeSupportStatus
[Permission: Employee]
Redirect a discussion request -
RegenerateAllInvoiceCodes
[Permission: Employee, Credentials: Finances.SystemSettings]
Regenerates every Invoice and Quote in the system to use the latest 'Invoice Code' format and 'Start Number' system settings. -
RemoveConversationFlagsWebSafe
[Permission: Anonymous]
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
[Permission: Anonymous]
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: Any Authenticated]
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.Invoices.DeleteFull/Limited, Sales.Quotes.DeleteFull/Limited]
Removes an invoice and rolls back Entry objects that were marked as Invoiced during its original creation. -
RemoveSubscription
[Permission: Any Authenticated]
Removes a Subscription to a MailingList for the specified Entity. If a subscription does not exist, the method returns False, overwise True. -
RemoveSubscriptionWebSafe
[Permission: Anonymous]
Removes a Subscription to a MailingList for the specified random Entity hash. If a subscription does not exist, the method returns False, overwise True. -
RemoveSubscriptions
[Permission: Employee]
Removes the Subscriptions to multiple MailingLists for the specified Entity. -
RemoveTransaction
[Permission: Employee, Credentials: Finances.Transactions.DeleteFull/Limited]
Saves a transaction and updates any applicable invoice balances. -
RenewVeetroSession
[Permission: Anonymous]
Attempts to validate a VeetroSession key and push a renewed cookie onto the caller. -
RestoreDeletedObject
[Permission: Employee]
A utility method intended for support staff. -
RestoreDeletedObjects
[Permission: Employee]
A utility method intended for support staff. -
Search
[Permission: Any Authenticated]
Searches entire system based on keywords using an optimized Lucene index search engine. -
SendMessageWebSafe
[Permission: Anonymous]
Posts a message to the conversation. -
SendPasswordWebSafe
[Permission: Anonymous]
E-mails a matching user a password reset link. -
SetAccount
[Permission: Employee, Credentials: Finances]
Saves an Account. An Account is analogous to a 'bank account' at a financial institution used for tracking transactions in/out of a business. -
SetActivity
[Permission: Employee]
Saves an Activity, returns the saved Activity with the new UniqueID when ActivityID was set with 0. -
SetArticle
[Permission: Employee, Credentials: Documents.KnowledgeBase]
Saves a KB Article -
SetArticleWithParent
[Permission: Employee, Credentials: Documents.KnowledgeBase]
Saves a KB Article -
SetAvatar
[Permission: Any Authenticated]
Saves an avatar image. -
SetBlog
[Permission: Employee, Credentials: Documents.Blogs]
Saves or Creates a Blog website -
SetBlogPost
[Permission: Employee, Credentials: Documents.Blogs]
Saves or Creates a Blog Post -
SetCalendar
[Permission: Employee]
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
[Permission: Employee, Credentials: Sales.Catalog]
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.Catalog.ManageCategories]
Saves a CatalogItemCategory or creates new if CatalogItemCategoryID is 0. -
SetCatalogItemPhoto
[Permission: Employee, Credentials: Sales.Catalog.ModifyFull/Limited]
Saves a CatalogItemPhoto. IfCatalogItemPhotoID = 0
, a new CatalogItemPhoto will be created. Returns a saved copy of the CatalogItemPhoto with the CatalogItemPhotoID only (does not return full image data.) -
SetCatalogItemWithPhoto
[Permission: Employee, Credentials: Sales.Catalog]
Saves a CatalogItem with photo. If CatalogItemID = 0, a new CatalogItem will be created. Returns a Saved copy of the CatalogItem including the newly created CatalogItemID. -
SetCompany
[Permission: Any Authenticated, Credentials: Contacts.Companies]
Saves a Company. IfEntityID = 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
[Permission: Anonymous]
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, Credentials: Finances.Expenses]
Saves a billable disbursement entry -
SetDocument
[Permission: Any Authenticated]
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
[Permission: Any Authenticated]
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. -
SetDraftTimesheets
[Permission: Any Authenticated,
Add/Remove draft timesheets -
SetEmployee
[Permissions: Employee, Credentials: Contacts.Employees]
Saves an Employee. IfEntityID = 0
, a new Employee will be created. Returns a Saved copy of the Employee including the newly created EntityID. -
SetEntityOwners
[Permission: Employee]
Share a contact with other users. Set RemoveParentLinks=true to remove the share. -
SetEntityPasswords
[Permission: Employee, Credentials: Contacts.People/Companies.ModifyFull]
Set new passwords for multiple non-employee entities, require strong passwords. -
SetEntryCustomFields
[Permission: Employee]
Sets Custom field values for the specified EntryID. If Field.Name's match existing values, old values are overwritten, otherwise new Fields are added to the Entry. -
SetEvent
[Permission: Any Authenticated, Credentials: Calendar.Events or Work.Timesheets or Work.ToDos]
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. The Credential requirements depend on theEvent.EventType
specified.Journal = Timesheet, ToDo = ToDo, Event = Event
. -
SetField
[Permission: Employee]
Saves a custom field. Specifying IsSysField as true and aSysFieldType
denotes that the field is a Template for use on the appropriate editor. -
SetFolder
[Permission: Employee, Credentials: Documents.Files]
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
[Permission: Employee, Credentials: Documents.Files.SystemSettings]
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, Credentials: Finances.Invoices, Sales.Quotes]
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. -
SetInvoiceFull
[Permission: Employee, Credentials: Finances.Invoices, Sales.Quotes]
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.
Use Items[i].OriginalEntry to pass in the timesheets/projects which need to be created. Set Item[i].OriginalEntry.EntryID=0 and Item[i].OriginalEntry.Flags="Project"/"Journal"/"ToDo" to create them. If they already exist please pass in the full object returned from GetInvoice or GetProject/GetEvent. Use Items[i].OriginalEntry.DateEnd_Temp for Timesheet.DateEnd, Items[i].OriginalEntry.Activity_Temp for Timesheet.Activity and Items[i].Date for Timesheet.DateStart or Project.DateStart. -
SetInvoicesFull
[Permission: Employee, Credentials: Finances.Invoices, Sales.Quotes]
Saves a batch of Invoices or Quotes. If InvoiceID = 0, a new Invoice will be created. Returns an array of the 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.
Use Items[i].OriginalEntry to pass in the timesheets/projects which need to be created. Set Item[i].OriginalEntry.EntryID=0 and Item[i].OriginalEntry.Flags="Project"/"Journal"/"ToDo" to create them. If they already exist please pass in the full object returned from GetInvoice or GetProject/GetEvent. Use Items[i].OriginalEntry.DateEnd_Temp for Timesheet.DateEnd, Items[i].OriginalEntry.Activity_Temp for Timesheet.Activity and Items[i].Date for Timesheet.DateStart or Project.DateStart. -
SetLead
[Permission: Employee, Credentials: Sales.Leads]
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
[Permission: Employee]
Sets the ProbabilityPercent attribute on a Lead -
SetMailingList
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Saves a MailingList. IfMailingListID = 0
, a new MailingList will be created. Returns a Saved copy of the MailingList including the newly created MailingListID. -
SetMailingListsSubscriptions
[Permission: Employee]
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. -
SetMessage
[Permission: Any Authenticated]. -
SetMessageAgainstEntry
[Permission: Any Authenticated]
Send an email against a Support Case. -
SetMessageMIME
[Permission: Any Authenticated]
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. IfNotationID = 0
, a new Notation will be created. Returns a Saved copy of the Notation including the newly created NotationID. -
SetOutlookSyncRecord
[Permission: Employee]
Save sync record. Used for WORKetc outlook plugin only. -
SetPerson
[Permission: Any Authenticated, Credentials: Contacts.People]
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. -
SetProductEntry
[Permission: Employee, Credentials: Sales.Catalog.CreateProductSales]
Saves a billable product entry -
SetProject
[Permission: Employee, Credentials: Work.Projects]
Saves a Project. IfEntryID = 0
, a new Entry will be created. Returns a Saved copy of the Project including the newly created EntryID. -
SetProposalWebSafe
[Permission: Anonymous]
Saves a Proposal. IfProposalID = 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, Credentials: Finances.SystemSettings]
Creates or updates a Shipping option. -
SetSubjectWebSafe
[Permission: Anonymous]
Sets the Subject for a conversation. -
SetSubscription
[Permission: Any Authenticated]
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, Credentials: Sales.Catalog.CreateProductSales]
Saves a billable subscription entry -
SetSubscriptionWebSafe
[Permission: Anonymous]
Creates a Subscription to a MailingList for the specified random Entity hash. If a subscription already exists, no duplication will occur, however the method will return False. Returns True when added successfully. -
SetSubscriptions
[Permission: Employee]
Creates Subscriptions to multiple MailingLists for the specified Entity. -
SetSupportCase
[Permission: Any Authenticated, Credentials: Work.SupportCases]
Saves a Support Case. Message is optional - when provided, the message will be appended to the Support Case. -
SetSupportCaseMessage
[Permission: Any Authenticated]
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
[Permission: Employee]
Saves a Notation against a Support Case. -
SetSupportCaseType
[Permission: Employee]
Saves a SupportCase Type definition -
SetSupportCaseWithMisc
[Permission: Any Authenticated, Credentials: Work.SupportCases]
Saves a Support Case. appendMisc is optional - you can append message or documents to Support Case. -
SetSupportCases
[Permission: Employee, Credentials: Work.SupportCases.Create/ModifyFull, Contacts.People.Create]
Batch create/update support cases.
Set GUID to any unique string for you to match the result with the parameters. Setting Relation.EntityID=0 and populating Relation.Name/Email will create a new Person if the person with the same name/email doesn't exist. No more than 50 per batch. -
SetTax
[Permission: Employee, Credentials: Finances.SystemSettings]
Saves or creates a Tax option. -
SetTemplate
[Permission: Employee]
Saves a Template. IfTemplateID = 0
, a new Template will be created. Returns a Saved copy of the Template including the newly created TemplateID.
A template can be of multiple types includingForm
(aka web form.) Templates are used in conjunction withProposal
documents. -
SetTransaction
[Permission: Employee, Credentials: Finances.Transactions]
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, Credentials: Contacts.Workgroups]
Saves a Workgroup. If Workgroup = 0, a new Workgroup will be created. Returns a Saved copy of the Workgroup including the newly created EntityID. -
SignInWithGoogleWebSafe
[Permission: Anonymous] -
StartMailing
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Enqueues recipients of a Template of type Email and initiates polling. -
StopMailing
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Suspends mailing of a template. -
StringToAddress
[Permission: Anonymous]
Utility method to attempt to parse an arbitrary string of text into an Address object. Things such as postal codes, country names, numbers and line breaks are used by the system to attempt a 'best guess' at placing data into the correct Street, Suburb, etc fields. -
SyncEntities
[Permission: Employee, Credentials: Contacts.DirectorySync]
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. -
UnFlagNotation
[Permission: Employee]
Removes flags to a discussion post -
UnFlagNotationRecipient
[Permission: Employee]
Removes flags to Discussion post recipients -
UserStartedTypingWebSafe
[Permission: Anonymous]
Set's a user's status to 'typing' -
UserStoppedTypingWebSafe
[Permission: Anonymous]
Removes a user's 'typing' status