Your use case. Our milestone. The 200th post in our "Kaizen Series: Continuous Improvement for Developer Experience" is coming up. Share Now

X
Skip to product menu
close
  • Recent Launches
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Recent Launches

New

Easy domain registration, transfer, and secured DNS management.

Try now
New

Payroll software with automated tax payments and filing.

Try now
New

Low-code IoT platform and solutions for connected businesses.

Try now
New

Business formation service to launch and grow your businesses.

Try now
New

Unified payment solution built for all businesses.

Try now
New

Comprehensive email security and archiving for every business.

Try now
Suites

Cloud-based qualitative data analysis tool.

Try now
New

Online community platform for individuals and businesses to grow their network and brand.

Try now
New

Modern retail POS to sell better, manage your entire business, and join the digital revolution.

Try now
SuitesNew

Unified project management platform for intelligent, data-driven work.

Try now
Suites

Unified platform for customer service and support teams.

Try now

Sales

CRM

Comprehensive CRM platform for customer-facing teams.

CRM
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
Thrive

Complete loyalty and affiliate management platform.

Thrive
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
Forms

Build online forms for every business need.

Forms
Social

All-in-one social media management software.

Social
Survey

Design surveys to reach and interact with your audience.

Survey
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Sites

Online website builder with extensive customisation options.

Sites
Backstage

End-to-end event management software.

Backstage
PageSense

Website conversion optimization and personalisation platform.

PageSense
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
Webinar

Webinar platform for webcasting online webinars.

Webinar
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
NEW
Domains

Easy domain registration, transfer, and secured DNS management.

Domains
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
Thrive

Complete loyalty and affiliate management platform.

Thrive
Publish

Manage all your local business listings on a single platform.

Publish
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

Desk

Helpdesk software to deliver great customer support.

Desk
Assist

Remote support and unattended remote access software.

Assist
Voice

Cloud Contact Center Software for businesses.

Voice
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
Bookings

Appointment scheduling app for consultations with customers.

Bookings
FSM

End-to-end field service management platform for service businesses.

FSM
Lens

Interactive remote assistance software with augmented reality.

Lens
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

Books

Powerful accounting platform for growing businesses.

Books
Expense

Effortless expense reporting platform.

Expense
Sign

Digital signature app for businesses.

Sign
Inventory

Powerful stock management and inventory control software.

Inventory
FREE
Invoice

100% Free invoicing solution.

Invoice
Billing

End-to-end billing solution for your business.

Billing
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Commerce

eCommerce platform to manage and market your online store.

Commerce
Checkout

Collect payments online with custom branded pages.

Checkout
Practice

Practice management software for accounting firms.

Practice
Solo

The all-in-one toolkit for solopreneurs.

Solo
NEW
Payments

Unified payment solution built for all businesses.

Payments
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email, Storage, and Collaboration

Mail

Secure email service for teams of all sizes.

Mail
Voice

Cloud Contact Center Software for businesses.

Voice
Sign

Digital signature app for businesses.

Sign
WorkDrive

Online file management for teams.

WorkDrive
Bookings

Appointment scheduling app for consultations with customers.

Bookings
Cliq

Stay in touch with teams no matter where you are.

Cliq
Notebook

Beautiful home for all your notes.

Notebook
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
Learn

Knowledge and learning management platform.

Learn
Office Integrator

Built in document editors for web apps.

Office Integrator
Writer

Word processor for focused writing and discussions.

Writer
TeamInbox

Shared inboxes for teams.

TeamInbox
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Show

Create, edit, and share slides with a sleek presentation app.

Show
Tables

Work management tool to connect people, processes, and information.

Tables
Sheet

Spreadsheet software for collaborative teams.

Sheet
Office Suite

Powerful collaborative work platform for teams.

Office Suite
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
ToDo

Collaborative task management for individuals and teams.

ToDo
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

Expense

Effortless expense reporting platform.

Expense
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
People

Organize, automate, and simplify your HR processes.

People
Sign

Digital signature app for businesses.

Sign
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
Shifts

Employee scheduling and time tracking app.

Shifts
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

Creator

Build custom apps to simplify business processes.

Creator
Assist

Remote support and unattended remote access software.

Assist
Vault

Online password manager for teams.

Vault
Directory

Workforce identity and access management solution for cloud businesses.

Directory
Lens

Interactive remote assistance software with augmented reality.

Lens
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
eProtect

Comprehensive email security and archiving for every business.

eProtect
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit

BI and Analytics

Analytics

Modern self-service BI and analytics platform.

Analytics
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

Project Management

Projects

Manage, track, and collaborate on projects with teams.

Projects
Sprints

Planning and tracking tool for scrum teams.

Sprints
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
Solo

The all-in-one toolkit for solopreneurs.

Solo
Suites
Projects Plus

Unified project management platform for intelligent, data-driven work.

Projects Plus

Developer Platforms

Creator

Build custom apps to simplify business processes.

Creator
Flow

Automate business workflows by creating smart integrations.

Flow
Office Integrator

Built in document editors for web apps.

Office Integrator
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
Tables

Work management tool to connect people, processes, and information.

Tables
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
Apptics

Application analytics for all apps.

Apptics
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI

IoT

NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
Projects Plus

Unified project management platform for intelligent, data-driven work.

Try now
Projects Plus
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Skip to main content

Sample Codes

All of Zoho CRM's APIs can be used through the Java SDK, to enable your custom application to perform data sync to the best degree. Here are the sample codes for all the API methods available in our SDK.

Assignment Rules Operations

MethodReturn TypeDescription
getAssignmentRulesAPIResponse<ResponseHandler>To fetch the assignment rules of a record.
getAssignmentRuleAPIResponse<ActionHandler>To fetch the assignment rule of a record.

Attachment Operations

ConstructorDescription
AttachmentsOperations(String moduleAPIName, String recordId)Creates an AttachmentsOperations class instance with the moduleAPIName and recordId.
MethodReturn TypeDescription
getAttachmentsAPIResponse<ResponseHandler>To fetch the list of attachments of a record.
uploadAttachmentsAPIResponse<ActionHandler>To upload attachments to a record.
deleteAttachmentsAPIResponse<ActionHandler>To delete the attachments that were added to a record.
deleteAttachmentAPIResponse<ActionHandler>To delete an attachment that was added to a record.
downloadAttachmentAPIResponse<ResponseHandler>To download an attachment that was uploaded to a record.
uploadLinkAttachmentsAPIResponse<ActionHandler>To upload a link as an attachment to a record.

Blueprint Operations

ConstructorDescription
BluePrintOperations(String recordId, String moduleAPIName)Creates a BluePrintOperations class instance with the recordId and moduleAPIName.
MethodReturn TypeDescription
getBlueprintAPIResponse<ResponseHandler>To get the next available transitions for that record, fields available for each transition, current value of each field, and validation(if any).
updateBlueprintAPIResponse<ActionResponse>To update a single transition at a time.

Bulk Read Operations

MethodReturn TypeDescription
createBulkReadJobAPIResponse<ActionHandler>To schedule a bulk read job to export records that match the criteria.
getBulkReadJobDetailsAPIResponse<ResponseHandler>To know the status of the bulk read job scheduled previously.
downloadResultAPIResponse<ResponseHandler>To download the result of the bulk read job. The response contains a zip file. Extract it to get the CSV or ICS file depending on the "file_type" you specified while creating the bulk read job

Bulk Write Operations

MethodReturn TypeDescription
uploadFileAPIResponse<ActionResponse>To upload a CSV file in ZIP format. The response contains the "file_id". Use this ID while making the bulk write request.
createBulkWriteJobAPIResponse<ActionResponse>To create a bulk write job to insert, update, or upsert records. The response contains the "job_id". Use this ID while getting the status of the scheduled bulk write job.
getBulkReadJobDetailsAPIResponse<ResponseWrapper>To know the status of the bulk read job scheduled previously.
downloadResultAPIResponse<ResponseHandler>To download the result of the bulk read job. The response contains a zip file. Extract it to get the CSV or ICS file depending on the "file_type" you specified while creating the bulk read job

Contact Roles Operations

MethodReturn TypeDescription
getContactRolesAPIResponse<ResponseHandler>To get the list of all contact roles.
createContactRolesAPIResponse<ActionHandler>To create contact roles.
updateContactRolesAPIResponse<ActionHandler>To update contact roles.
deleteContactRolesAPIResponse<ActionHandler>To delete contact roles.
getContactRoleAPIResponse<ResponseHandler>To get specific contact role.
updateContactRoleAPIResponse<ActionHandler>To update specific contact role.
deleteContactRoleAPIResponse<ActionHandler>To delete specific contact role.
getAllContactRolesOfADealAPIResponse<ActionHandler>This method is used to get all Contact Roles of deal and print the response.
getContactRolesOfDealAPIResponse<ResponseHandler>This method is used to get Contact Roles of deal and print the response.
addContactRolesToDealAPIResponse<ActionHandler>This method is used to add Contact Role to deal and print the response.
remContactRolesDealAPIResponse<ActionHandler>This method is used to remove Contact Roles from deal and print the response.

Currencies Operations

MethodReturn TypeDescription
getCurrenciesAPIResponse<ResponseHandler>To get the list of all currencies available for your org.
addCurrenciesAPIResponse<ActionHandler>To add new currencies to your org.
updateCurrenciesAPIResponse<ActionHandler>To update the currencies' details of your org.
enableMultipleCurrenciesAPIResponse<BaseCurrencyAction
Handler>
To enable multiple currencies for your org.
updateBaseCurrencyAPIResponse<BaseCurrencyAction
Handler>
To update the base currency details of your org.
getCurrencyAPIResponse<ResponseHandler>To get the details of specific currency.
updateCurrencyAPIResponse<ActionHandler>To update the details of specific currency.

Custom View Operations

ConstructorDescription
CustomViewsOperations(String module)Creates a CustomViewsOperations class instance with the moduleAPIName.
MethodReturn TypeDescription
getCustomViewsAPIResponse<ResponseHandler>To get the list of all custom views in a module.
getCustomViewAPIResponse<ResponseHandler>To get the details of specific custom view in a module.

Email Templates Operations

MethodReturn TypeDescription
getEmailTemplatesAPIResponse<ResponseHandler>To fetch all the email templates.
getEmailTemplateAPIResponse<ActionHandler>To fetch a particular email template.

Field Attachment Operation

MethodReturn TypeDescription
getFieldAttachmentsAPIResponse<ResponseHandler>To get all the field attachments.

Fields Metadata Operations

ConstructorDescription
FieldsOperations(String module)Creates a FieldsOperations class instance with the module.
MethodReturn TypeDescription
getFieldsAPIResponse<ResponseHandler>To get the meta details of all fields in a module.
getFieldAPIResponse<ResponseHandler>To get the meta details of specific field in a module.

Files Operations

MethodReturn TypeDescription
uploadFilesAPIResponse<ActionHandler>To upload files and get their encrypted IDs.
getFileAPIResponse<ResponseHandler>To get the uploaded file through its encrypted ID.

Inventory Templates Operations

MethodReturn TypeDescription
getInventoryTemplatesAPIResponse<ResponseHandler>To fetch all the inventory templates.
getInventoryTemplateAPIResponse<ActionHandler>To fetch a particular inventory template.

Layouts Operations

ConstructorDescription
LayoutsOperations(String module)Creates a LayoutsOperations class instance with the moduleAPIName.
MethodReturn TypeDescription
getLayoutsAPIResponse<ResponseHandler>To get the details of all the layouts in a module.
getLayoutAPIResponse<ResponseHandler>To get the details (metadata) of a specific layout in a module.

Modules Operations

MethodReturn TypeDescription
getModulesAPIResponse<ResponseHandler>To get the details of all the modules.
getModuleAPIResponse<ResponseHandler>To get the details (metadata) of a specific module.
updateModuleByAPINameAPIResponse<ActionHandler>To update the details of a module by its module API name.
updateModuleByIdAPIResponse<ActionHandler>To update the details of a module by its ID.

Notes Operations

MethodReturn TypeDescription
getNotesAPIResponse<ResponseHandler>To get the list of notes of a record.
createNotesAPIResponse<ActionHandler>To add new notes to a record.
updateNotesAPIResponse<ActionHandler>To update the details of the notes of a record.
deleteNotesAPIResponse<ActionHandler>To delete the notes of a record.
getNoteAPIResponse<ResponseHandler>To get the details of a specific note.
updateNoteAPIResponse<ActionHandler>To update the details of an existing note.
deleteNoteAPIResponse<ActionHandler>To delete a specific note.

Notification Operations

MethodReturn TypeDescription
enableNotificationsAPIResponse<ActionHandler>To enable instant notifications of actions performed on a module.
getNotificationDetailsAPIResponse<ResponseHandler>To get the details of the notifications enabled by the user.
updateNotificationsAPIResponse<ActionHandler>To update the details of the notifications enabled by a user. All the provided details would be persisted and rest of the details would be removed.
updateNotificationAPIResponse<ActionHandler>To update only specific details of a specific notification enabled by the user. All the provided details would be persisted and rest of the details will not be removed.
disableNotificationsAPIResponse<ActionHandler>To stop all the instant notifications enabled by the user for a channel.
disableNotificationAPIResponse<ActionHandler>To disable notifications for the specified events in a channel.

Organization Operations

MethodReturn TypeDescription
getOrganizationAPIResponse<ResponseHandler>To get the details of your organization.
uploadOrganizationPhotoAPIResponse<ActionHandler>To upload a photo of your organization.

Pipeline Operations

MethodReturn TypeDescription
transferDeleteAPIResponse<ResponseHandler>To transfer and delete./td>
getPipelinesAPIResponse<ActionHandler>To get all the pipelines.
createPipelinesAPIResponse<ActionHandler>To create pipelines.
updatePipelinesAPIResponse<ActionHandler>To update pipelines.
getPipelineAPIResponse<ResponseHandler>To get a particular pipeline.
updatePipelineAPIResponse<ActionHandler>To update pipeline.

Profile Operations

ConstructorDescription
ProfilesOperations(OffsetDateTime ifModifiedSince)Creates a ProfilesOperations class instance with the value of the If-Modified-Since header.
MethodReturn TypeDescription
getProfilesAPIResponse<ResponseHandler>To get the list of profiles available for your organization.
getProfileAPIResponse<ResponseHandler>To get the details of a specific profile.

Query (COQL) Operation

MethodReturn TypeDescription
getRecordsAPIResponse<ResponseHandler>To get the records from a module through a COQL query.

Records Operations

MethodReturn TypeDescription
getRecordAPIResponse<ResponseHandler>To get a specific record from a module.
updateRecordAPIResponse<ActionHandler>To update a specific record in a module.
deleteRecordAPIResponse<ActionHandler>To delete a specific record from a module.
getRecordsAPIResponse<ResponseHandler>To get all records from a module.
createRecordsAPIResponse<ActioneHandler>To insert records in a module.
updateRecordsAPIResponse<ActionHandler>To update records in a module.
deleteRecordsAPIResponse<ActionHandler>To delete records from a module.
upsertRecordsAPIResponse<ActionHandler>To insert/update records in a module.
getDeletedRecordsAPIResponse<DeletedRecords
Handler>
To get the deleted records from a module.
searchRecordsAPIResponse<ActionHandler>To search for records in a module that match certain criteria, email, phone number, or a word.
convertLeadAPIResponse<ConvertActionHandler>To convert records(Leads to Contacts/Deals).
getPhotoAPIResponse<DownloadHandler>To get the photo of a record.
uploadPhotoAPIResponse<FileHandler>To upload a photo to a record.
deletePhotoAPIResponse<FileHandler>To delete the photo of a record.
assignTeritoriesToMultipleRecordsAPIResponse<MassUpdateAction
Handler>
To assign territories to multiple records in a module.
assignTerritoryToRecordAPIResponse<MassUpdateAction
Handler>
To assign territories to records in a module.
removeTerritoriesFromMultipleRecordsAPIResponse<MassUpdateAction
Handler>
To remove territories from record in a module.
removeTerritoriesFromRecordAPIResponse<MassUpdateAction
Handler>
To remove territories from multiple records in a module./td>
massUpdateRecordsAPIResponse<MassUpdateAction
Handler>
To update the same field for multiple records in a module.
getMassUpdateStatusAPIResponse<MassUpdateAction
Handler>
To get the status of the mass update job scheduled previously.

Related List Operations

ConstructorDescription
RelatedListsOperations(String module)Creates a RelatedListsOperations class instance with the moduleAPIName.
MethodReturn TypeDescription
getRelatedListsAPIResponse<ResponseHandler>To get the details of all the related lists of a module.
getRelatedListAPIResponse<ResponseHandler>To get the details of a specific related list of a module.

Related Records Operations

ConstructorDescription
RelatedRecordsOperations(String relatedListAPIName, Long recordId, String moduleAPIName)Creates a RelatedRecordsOperations class instance with the relatedListAPIName, recordId, and moduleAPIName.
MethodReturn TypeDescription
getRelatedRecordsAPIResponse<ResponseHandler>To get list of records from the related list of a module.
updateRelatedRecordsAPIResponse<ActionHandler>To update the association/relation between the records.
delinkRecordsAPIResponse<ActionHandler>To delete the association between the records.
getRelatedRecordAPIResponse<ResponseHandler>To get the records from a specific related list of a module.
updateRelatedRecordAPIResponse<ActionHandler>To update the details of a specific record of a related list in a module.
delinkRecordAPIResponse<ActionHandler>To delete a specific record from the related list of a module.
getRelatedRecordsUsingExternalIdAPIResponse<ActionHandler>This method is used to get the related list records and print the response.
updateRelatedRecordsUsingExternalIdAPIResponse<ResponseHandler>This method is used to update the relation between the records and print the response.
deleteRelatedRecordsUsingExternalIdAPIResponse<ActionHandler>This method is used to delete the association between modules and print the response.
getRelatedRecordUsingExternalIdAPIResponse<ActionHandler>This method is used to get the single related list record and print the response
updateRelatedRecordUsingExternalIdAPIResponse<ActionHandler>This method is used to update the relation between record and print the response.
deleteRelatedRecordUsingExternalIdAPIResponse<ActionHandler>This method is used to delete the association between modules and print the response.

Role Operations

MethodReturn TypeDescription
getRolesAPIResponse<ResponseHandler>To get the list of all roles available in your organization.
getRoleAPIResponse<ResponseHandler>To get the details of a specific role.

Send Mail Operations

MethodReturn TypeDescription
getEmailAddressesAPIResponse<ResponseHandler>To get a list of all the email addresses.
sendEmailAPIResponse<ResponseHandler>To send mail.

Shared Records Operations

ConstructorDescription
ShareRecordsOperations(Long recordId, String moduleAPIName)Creates a ShareRecordsOperations class instance with the recordId and moduleAPIName.
MethodReturn TypeDescription
getSharedRecordDetailsAPIResponse<ResponseHandler>To get the details of a record shared with other users.
shareRecordAPIResponse<ActionHandler>To share a record with other users in the organization.
updateSharePermissionsAPIResponse<ActionHandler>To
  • Update the sharing permissions of a record granted to users as Read-Write, Read-only, or grant full access.

  • Revoke access given to users to a shared record.

  • Update the access permission to the related lists of the record that was shared with the user.

revokeSharedRecordAPIResponse<DeleteActionHandler>To revoke access to a shared record.

Tags Operations

MethodReturn TypeDescription
getTagsAPIResponse<ResponseHandler>To get the list of all tags in your organization.
createTagsAPIResponse<ActionHandler>To create tags.
updateTagsAPIResponse<ActionHandler>To update multiple tags.
updateTagAPIResponse<ActionHandler>To update a specific tag.
deleteTagAPIResponse<ActionHandler>To delete a specific tag from the module.
mergeTagsAPIResponse<ActionHandler>To merge two tags.
addTagsToRecordAPIResponse<RecordActionHandler>To add tags to a specific record.
removeTagsFromRecordAPIResponse<RecordActionHandler>To remove tags from a record.
addTagsToMultipleRecordsAPIResponse<RecordActionHandler>To add tags to multiple records.
removeTagsFromMultipleRecordsAPIResponse<RecordActionHandler>To remove tags from multiple records.
getRecordCountForTagAPIResponse<RecordActionHandler>To get the record count for a tag.

Taxes Operations

MethodReturn TypeDescription
getTaxesAPIResponse<ResponseHandler>To get the taxes of your organization.
createTaxesAPIResponse<ActionHandler>To add taxes to your organization.
updateTaxesAPIResponse<ActionHandler>To update the existing taxes of your organization.
deleteTaxesAPIResponse<ActionHandler>To delete multiple taxes from your organization.
getTaxAPIResponse<ResponseHandler>To get the details of a specific tax.
deleteTaxAPIResponse<ActionHandler>To delete a specific tax from your organization.

Territory Operations

MethodReturn TypeDescription
getTerritoriesAPIResponse<ResponseHandler>To get the list of all territories.
getTerritoryAPIResponse<ResponseHandler>To get the details of a specific territory.

Users Operations

MethodReturn TypeDescription
getUsersAPIResponse<ResponseHandler>To get the list of users in your organization.
createUserAPIResponse<ActionHandler>To add a user to your organization.
updateUsersAPIResponse<ActionHandler>To update the existing users of your organization.
getUserAPIResponse<ResponseHandler>To get the details of a specific user.
updateUserAPIResponse<ActionHandler>To update the details of a specific user.
deleteUserAPIResponse<ActionHandler>To delete a specific user from your organization.

Variable Groups Operations

MethodReturn TypeDescription
getVariableGroupsAPIResponse<ResponseHandler>To get the list of all variable groups available for your organization.
getVariableGroupByIdAPIResponse<ResponseHandler>To get the details of a variable group by its group ID.
getVariableGroupByAPINameAPIResponse<ResponseHandler>To get the details of a specific variable group by its API name.

Variables Operations

MethodReturn TypeDescription
getVariablesAPIResponse<ResponseHandler>To get the list of variables available for your organization.
createVariablesAPIResponse<ActionHandler>To add new variables to your organization.
updateVariablesAPIResponse<ActionHandler>To update the details of variables.
deleteVariablesAPIResponse<ActionHandler>To delete multiple variables.
getVariableByIdAPIResponse<ResponseHandler>To get the details of a specific variable by its unique ID.
updateVariableByIdAPIResponse<ActionHandler>To update the details of a specific variable by its unique ID.
deleteVariableAPIResponse<ActionHandler>To delete a specific variable.
getVariableForAPINameAPIResponse<ResponseHandler>To get the details of a variable by its API name.
updateVariableByAPINameAPIResponse<ActionHandler>To update the details of a variable by its API name.

Wizards Operations

MethodReturn TypeDescription
getWizardsAPIResponse<ResponseHandler>To get the list of wizards available.
getWizardAPIResponse<ResponseHandler>To get a particular wizard.