JUMP TOSynergist REST API v3.9OVERVIEWWhich API to useGetting started with the Synergist APIUsing the APIWhat's newAPI syntaxStructure of an API callREST verbsHashing - Sha512Key parametersError codesPassing data array to an API requestRecord versioningEncoding special charactersViewsUsing viewsTable of viewsData viewer viewsJob create views (version 12.95 and above)Key field filtersView menusSortingModelsUsing data modelsMeta-dataENDPOINTSActivities APIActivity ListActivity List - KanbanActivity DetailsCreateUpdateDeleteFollow UpAdd a commentActivity History ListActivity Type LookupClient ListClient Contact LookupOwner LookupResources lookupSecondary OwnersPriority LookupStatus LookupTeam LookupTime Due LookupCategory LookupAttachments APIAttachments ListAttachment DetailsCreateUpdateDeleteAttachment Print - Base64Billing plan APIBilling Plan ListBilling Plan DetailsCalendar APIUsers ListEstimates ListRequisitions ListCalendar Display CompactCalendar DisplayCalendar LoadingCalendar RefreshShow EstimateHide EstimateCreateUpdateDeleteMyCalendar ListMyCalendar List (Deprecated)Checklist Header APIChecklist Headers ListCreateUpdateDeleteReorder HeadersList TemplatesHide Completed ItemsShow Completed ItemsChecklist items APIChecklist Items ListCreateUpdateDelete ItemComplete ItemUncomplete ItemReorder ItemsClients APIClient ListClient DetailsClient FinancialOrganizationsCreateUpdateDeleteActive OnActive OffPromoteRevert To ProspectPut On StopPut Off StopCountries LookupHandlers LookupSources LookupClient Types LookupMarket Sectors LookupStatus Grades LookupLead Ratings LookupClient Contacts APIContacts ListContacts DetailsCreateUpdateDeleteMake ActiveMake InactiveOpt In (GDPR)Opt Out (GDPR)Verify Opt-In (GDPR)Don't Verify Opt-In (GDPR)Lookup TitlesLookup CountriesCompanies APICompany ListCompany Timesheet SettingsData viewer APIRunning a data viewer reportStartCheck statusEstimates (time) APIEstimate listEstimates List (deprecated)Expense SheetCompany ListSupplier ListCreateUpdateExpense Sheet StatusExpense Sheet Print TemplatesExpense Sheet Print (Base64)Expense Sheet Print (Create a file)Expense Sheet CopyExpense Sheet DefaultsExpense Sheet LinesExpense Sheet Submit SingleExpense Sheet Submit MultiExpense Sheet Approve SingleExpense Sheet Approve MultiExpense Sheet Unapprove SingleExpense Sheet Unapprove MultiExpense Sheet Process SingleExpense Sheet Process MultiExpense Sheet Post SingleExpense Sheet Post MultiExpense Sheet All SingleExpense Sheet All MultiExpense Sheet Return SingleExpense Sheet Return MultiExpense Sheet Delete SingleExpense Sheet Delete MultiExpense Sheet List SingleExpense Sheet List MultiExpense Sheet List AllExpense LinesClient ListJobs ListPhase ListStages ListCreateUpdateExchange RatesCurrency CodesSupply TypesSupply Types ListAttachment ViewAttachment RemoveAttachment OpenAttachment UploadExpense Line CopyExpense Line SubmitExpense Line SubmittableExpense Line ApproveExpense Line HoldExpense Line QueryExpense Line ResubmitExpense Line RejectExpense Sheet LineExpense Line Delete SingleExpense Line Delete MultiExchange rates listInvoices APIInvoice ListInvoice DetailsJob APIJobs ListJob DetailsJob FinancialsJob DatesCosts and ChargesCreateUpdateCompleteUn-completeDeleteJob Sales StatusJob Client ListJob Client ContactJob ProjectJob Campaign (Sub Project)Job Type ListJob Handler ListJob Team ListKanban APIKanban Board ListKanban Single Board HeaderKanban Board ColumnsKanban Board EntitiesKanban Move EntityKanban Activity TypesLookup & Custom field properties APILookup properties listLookup properties detailsLookups - filtered by parentLookups & Custom fields APILookups listLookups detailsCreateCreate - with parent contextPhase APIPhase ListPhase DetailsPhase FinancialsPhase DatesCosts and ChargesCompleteUn-completeUpdateUpdate dates - version 12.95 and abovePurchase invoicesPurchase Invoices ListPurchase Invoice DetailsPurchasing APIPurchase ListPurchase DetailsCreateUpdateDeleteExpense Sheet List SingleApproveUnapprovePromote (Make Real)CancelQuote Pick OnQuote Pick OffEstimate Pick OnEstimate Pick OffOption OnOption OffInvestment OnInvestment OffChange CurrencyChange SupplierSupplier ListExpenses ListSupply TypesOrderers ListCurrenciesJob ListPurchase Order DescriptionsPrint purchase order (Base64)Print purchase order (Create a file)List Print Templates / FilesSupplier ContactsRelated InvoicesTax CodesQuotes APIQuote Lines ListSuppliers APISupplier listSupplier DetailsSupplier Financial DetailsCreateUpdateDeleteSupplier Contacts APIContact ListContact DetailsCreateUpdateDeleteMake ActiveMake InactiveTitlesCountriesThermos APIThermos ListTimesheets (actuals) APITimesheet ListTimesheet DetailsDeleteTimesheets (Pending) APIPending Timesheets ListPending Timesheets DetailsSubmitted Pending Timesheets ListCreateUpdateDeleteTimesheet Summary TableCompany SettingsPending CopyPending SubmitPending ResubmitTimerUser Jobs ListCompany ListResource ListMaterial Type ListMaterial ListActivity Type ListWorkflow Type ListAdd Job to TimesheetRemove Job from TimesheetPrint TimesheetTimesheet Weekly ChangeShow OvertimeHide OvertimeTimesheet Weekly Pending ListTimesheet Pending ListTimesheet WeeklyMaterial Sheet WeeklyClear TimersTimer StatusClients ListJobs ListPhases ListWorkflows ListTask Descriptions ListCharge Code ListTimesheet Weekly DateSubmitted Pending Timesheets ListWorkflow APIWorkflow list (schedule of stages)Workflow details (stage)Complete stageUn-complete stageFM TABLESDeletion tracking APIDeletion tracking listStaff resources APIResources ListResource - full detailsUsers APIUser listUser list (minimum)User list (timesheetweeklysettings)User list (calendarsettings)User settingsUser detailsStages APIStages ListSystem APISystem ParametersPowered by ViewsViews - Synergist's saved filtersA 'view' in Synergist is a named predefined query. For example the 'Active clients' view will list all organizations that are 'Clients' and flagged as active on the system.
