For AI agents: visit https://developers.zuper.co/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Zuper Pro
HomeGuidesAPI ReferenceChangelogDiscussions
v1.0

Log InZuper Pro
API Reference
Log In
v1.0HomeGuidesAPI ReferenceChangelogDiscussions

Zuper Pro API

  • Getting Started with Zuper API
  • Generating API Key

WORK ORDER MANAGEMENT

  • Jobs
    • Job CRUD
      • Create a Jobpost
      • Get Jobsget
      • Get Job Detailsget
      • Update Job Assignmentpost
      • Accept / Decline Jobpost
      • Update a Jobput
      • Generate / Share Job Card PDFpost
      • Delete a Jobdel
      • Restore Jobpost
    • Job Status
      • Update Status & Checklistput
      • Update Job Checklistput
      • Rollback / Delete a Job Statusput
    • Job Schedule
      • Reschedule Jobput
      • Get Unscheduled Jobsget
      • Assisted Schedulingget
      • Conflicting Jobs & Time offput
    • Job Timelog
      • Create a Job Timelogpost
      • Update a Job Timelogput
      • Get Job Timelogget
      • Get Job Timelog Summaryget
      • Get Job Timelog Summary Detailsget
      • Delete Job Timelogdel
    • Job Note
      • Create Job Notepost
      • Get Job Notesget
      • Update Job Noteput
      • Change Note Privacyput
      • Delete Job Notedel
    • Job Routes
      • Create Routepost
      • Get Routesget
      • Get Route Detailsget
      • Get Routes Countget
      • Update Route Detailsput
      • Add Job To Routeput
      • Assign User Team To Routepost
      • Unassign User Team To Routepost
      • Reassign Job From Routepost
      • Reorder Jobs In Routeput
      • Clone Job Routepost
      • Optimize Job Routepost
      • Lock Job Routeput
      • Delete Job Routedel
      • Delete Job From Routedel
    • Recurring Jobs
      • Get Recurring Jobsget
      • Update Recurring Job Scheduleput
      • Delete Reccurring Jobdel
    • Job Attachments
      • Add Job Attachmentpost
      • Update Job Attachmentput
      • Delete Job Attachmentdel
    • Expense
      • Create Expensepost
      • Update Expenseput
      • Get All Expensesget
      • Get Expense Detailsget
      • Delete Expensedel
    • Job Category
      • Create Job Categorypost
      • Get All Job Categoryget
      • Edit Job Categoryput
      • Delete a job categorydel
      • Reorder Job Categoryput
    • 📁Albums
      • /attachments/folderspost
      • /attachments/foldersget
      • /attachments/folders/{folder_uid}put
      • /attachments/folders/{folder_uid}del
      • /attachments/folders/{folder_uid}/associationpost
      • /attachments/folders/{folder_uid}/associationdel
      • /attachments/folders/{folder_uid}/sharepost
      • /attachments/folders/{folder_uid}/shareget
      • /attachments/folders/{folder_uid}/share/{share_uid}put
      • /attachments/folders/{folder_uid}/share/{share_uid}del
    • Gallery
      • Photo Comments
        • Create Commentpost
        • Get Commentsget
        • Update Commentput
        • Delete Commentdel
      • Galleryget
      • Bulk Delete Attachmentsdel
      • Bulk Recover Attachmentsput
    • Appointments
      • Create New Appointmentpost
      • Get Appointmentsget
      • Get Appointment Detailsget
      • Update Appointmentput
      • Update Appointment Associationspatch
      • Appointment - Service task reorderpatch
      • Assign Appointmentpost
      • Delete Appointmentdel
    • Financials
      • Get Job Financial Summaryget
  • Tasks
    • Create Service Taskspost
    • Get Service Tasksget
    • Get Service Task Detailsget
    • Update Service Task Statusput
    • Update Service Taskput
    • Assign Service Taskput
    • Reorder Service Taskspost
    • Bulk Action Service Taskpost
    • Delete Service Taskdel
  • Projects
    • Project CRUD
      • Create Projectpost
      • Get All Projectsget
      • Get Project Detailsget
      • Update a projectput
      • Update Project Statusput
      • Update Assignmentpost
      • Delete Projectdel
    • Project Jobs
      • Link Job to Projectpost
      • Reorder Jobs in Projectput
      • Remove Job from Projectdel
    • Milestone
      • Create Milestonepost
      • Update Milestoneput
      • Update Milestone Statusput
      • Delete Milestonedel
    • Phases
      • Create Phasepost
      • Update Phaseput
      • Update Phase Itemspost
      • Get All Phasesget
      • Reorder Phaseput
      • Reorder Phase Itemsput
      • Delete Phasedel
      • Delete Phase Itemsput
    • Dependencies
      • Create Dependencypost
      • Update Dependencyput
      • Check Dependencypost
      • Delete Dependencydel
    • Financials
      • /projects/{project_uid}/finance/statsget
  • Measurements
    • Create Measurementpost
    • Get Measurementsget
    • Get Measurement Detailsget
    • Update Measurementput
    • Delete Measurementdel
    • Create Measurement Tokenpost
    • Update Custom Measurement Tokenput
    • Delete Custom Measurement Tokendel
    • Upload Measurementpost
    • Sync Measurementpost
  • Customers
    • Customer CRUD
      • Create a Customerpost
      • Get all Customersget
      • Get Customer Detailsget
      • Update Customerput
      • Merge Customersget
      • Activate / Deactivate Customerpost
      • Delete Customerdel
      • Restore Customerpost
      • /customers/{customer_uid}/summaryget
    • Attachments
      • Add Attachmentspost
      • Update Attachmentput
      • Delete Attachmentdel
    • Customer Notes
      • Create Customer Notespost
      • Get Customer Noteget
      • Change Note Privacyput
      • Update Customer Notesput
      • Delete Customer Notesdel
  • Organizations
    • Organization CRUD
      • Create Organizationpost
      • Get Organizationsget
      • Get Organization Detailsget
      • Update Organization Detailsput
      • Activate / Deactivate Organizationput
      • Delete Organizationdel
      • Restore Organizationpost
    • Attachments
      • Add Organization Attachmentspost
      • Update Organization Attachmentput
      • Delete Organization Attachmentdel
    • /organization/{organization_uid}/summaryget
  • Properties
    • Property CRUD
      • Create Propertypost
      • Get All Propertiesget
      • Get Property Detailsget
      • Update Property Detailsput
      • Activate / Deactivate Propertyput
      • Delete Propertydel
      • Recover Propertypost
    • /property/{property_uid}/summaryget
  • Assets
    • Get All Assetsget
    • Get Asset Detailsget
    • Create Assetpost
    • Delete Assetdel
    • Update Assetput
    • Update Asset Statusput
    • Activate Assetput
    • Asset Bulk Actionpost
    • Recover Assetpost
    • Create Asset Cardpost
    • Get Asset Historyget
    • Create Asset Actionpost
    • Get Asset Import Templateget
    • Get Sample Import Dataget
    • Import Asset Datapost
    • /assets/{asset_uid}/summaryget
  • Documents
    • Create Documentpost
    • Get All Documentsget
    • Get Documentget
    • Download Documentget
    • Update Documentput
    • Send Documentpost
    • Delete Documentdel
  • Service Contracts
    • Create service contractpost
    • Get Service Contractsget
    • Get Service Contract Detailsget
    • Update service contractput
    • Delete Service Contractdel
    • Recover Contractpost
    • Activate/Deactivate Service Contractput
    • Update Approval Statusput
    • Renew Service Contractput
    • Send To Customerpost
  • Requests
    • Create Requestpost
    • Get Requestsget
    • Get Request Detailsget
    • Update Requestput
    • Update Request statusput
    • Delete Requestdel
  • 🗨️Messaging & Chats
    • Send Message To Stream Channelpost
    • Add Users To Stream Channelpost
  • Commissions
    • /commissionspost
    • /commissions/{commission_uid}put
    • /commissionsget
    • /commissions/{commission_uid}get
    • /commissions/{commission_uid}del

Inventory

  • Parts & Services
    • Product Master
      • Create a Productpost
      • Get all Productsget
      • Get a Product Detailsget
      • Update a Productput
      • Delete a Productdel
    • Product Groups
      • Create Products Grouppost
      • Get All Products Groupget
      • Get Products Group Detailsget
      • Update Products Groupput
      • Delete Products Groupdel
      • Add Products to Products Grouppost
      • Remove Products from Grouppost
      • Activate Products Groupput
    • Product Category
      • Create Product Categorypost
      • Get Product Categoriesget
      • Update Product Categoryput
      • Delete Product Categorydel
  • Stock Transactions
    • Create Inward Transcationpost
    • Create Outward Transactionpost
    • Create Transferpost
    • Get all Products Transactionget
    • Get Product transaction detailsget
    • Update Overall Stock
    • Transfer Order
      • Create Transfer Orderpost
      • Get all Transfer Ordersget
      • Get a Transfer Orderget
      • Update Transfer Orderput
      • Update Status of Transfer Orderput
      • Delete Transfer Orderdel
      • Transfer Order Cardpost
      • Create Transfer Order Attachmentpost
      • Update Transfer Order Attachmentput
      • Delete Transfer Order Attachmentdel
  • Pricelist
    • Create Pricelistpost
    • Get all Pricelistget
    • Get a Pricelist Detailsget
    • Update a Pricelistput
    • Activate / Deactivateput
    • Delete Pricelistdel
  • Vendor Management
    • Vendor Catalogs
      • /vendors/{vendor_uid}/catalogpost
      • /vendors/{vendor_uid}/catalog/{catalog_uid}put
      • /vendor_catalogsget
      • /vendors/{vendor_uid}/catalog/{catalog_uid}del
    • Vendor CRUD
      • /vendors/{vendor_uid}get
      • /vendorsget
      • /vendors/{vendor_uid}del
      • /vendors/{vendor_uid}put
      • /vendorspost
  • Purchase Orders
    • /purchase_orderspost
    • /purchase_orders/{purchase_order_uid}put
    • /purchase_orders/{purchase_order_uid}del
    • /purchase_ordersget
    • /purchase_orders/{purchase_order_uid}get
    • /purchase_orders/{purchase_order_uid}/statusput
    • /purchase_orders/{purchase_order_uid}/sendpost

Accounting

  • Quotes
    • Create a Quotepost
    • Get all Quoteget
    • Get a Quoteget
    • Update a Quoteput
    • Update Proposal Statusput
    • Send a Quotepost
    • Bulk Action Quotepost
    • Delete a Proposaldel
    • Recover a Quotepost
    • /estimate/{estimate_uid}/unarchiveput
  • Proposal
    • Create a Proposalpost
    • Get all Proposalget
    • Get Proposal Detailsget
    • Update a Proposalput
    • Update Proposal Optionspatch
    • Delete a Proposaldel
    • Packages
      • Create a Packagepost
      • Get all Packagesget
      • Get a Packageget
      • Update a Packageput
      • Activate/Deactivate a Packageput
      • Reorder Packagespost
      • Delete a Packagedel
    • Templates
      • Create a Templatepost
      • Get all Templatesget
      • Get a Templateget
      • Update a Templateput
      • Activate/Deactivate a Templateput
      • Delete a Templatedel
  • Invoices
    • Create a Invoicepost
    • Get all Invoiceget
    • Get Invoice Detailsget
    • Update a Invoiceput
    • Update Invoice Statusput
    • Send a Invoicepost
    • Delete a Invoicedel
    • Restore a Invoicepost
    • /invoice/{invoice_uid}/unarchiveput
  • Payments
    • Payment Request
      • Create Payment Requestpost
      • Get All Payment Requestget
      • Cancel Payment Requestput
      • Delete Payment Requestdel
      • Resend Payment Request Emailpost
      • Get Payment Request Detailsget
    • Get paymentsget
    • Get payment detailsget
    • Void a paymentput
  • Credit Notes
    • Create Credit Notepost
    • Get All Credit Notesget
    • Get Credit Note Detailsget
    • Delete Credit Notedel
    • Credit Note History
      • Get Customer Credit Historiesget

Zuper Connect

  • Calls
    • Get Callspost
    • Get Call Detailsget
    • Get Call Analyticspost
    • Get Call Activity get
  • Conversations
    • Get Conversationspost
    • Get Conversation Detailsget
    • Get Conversation Messagespost
    • Send a messagepost

User Management

  • Users
    • Create Userpost
    • Get All Usersget
    • Get User Detailsget
    • Update User Detailsput
    • Delete Userdel
    • Activate / Deactivate Userpost
    • User Skills
      • Create User Skillspost
      • Get User Skillsget
      • Update User Skillsput
      • Delete User Skillsdel
    • User Timelogs
      • Get Users Timelogget
      • Get User Timelog Detailsget
  • Teams
    • Create Teampost
    • Get All Teamsget
    • Get Team Detailsget
    • Update Team Detailsput
    • Delete Teamdel
    • Restore Teampost
    • Assign/Unassign User
      • Assign User To Teampost
      • Unassign User From Teampost
  • Timesheets
    • Timesheets CRUD
      • Get Timesheetsget
      • Get Timesheet Summaryget
      • Create Timesheetpost
      • Update Timesheetput
      • Delete Timesheetdel
    • Timeoff
      • Create Timeoff Requestpost
      • Get Timeoff Requestsget
      • Get Timeoff Request Detailsget
      • Edit Timeoff Requestput
      • Update Approval Statusput
      • Delete Timeoff Requestdel
    • Timesheet Location
      • Create Timesheet Locationpost
      • Get Timesheet Locationget
      • Get Location Detailsget
      • Update Timesheet Locationput
      • Delete Timesheet Locationdel
    • Timeoff Request Type
      • Create Timeoff Request Typepost
      • Get Timeoff Request Typeget
      • Update Timeoff Request Typeput
      • Delete Timeoff Request Typedel
      • Reorder Timeoff Request Typepost
    • Timeoff Availability
      • Create Timeoff Availabilitypost
      • Get Timeoff Availabilityget
      • Update Timeoff Availabilityput
      • Delete Timeoff Availabilitydel
  • Trade Types
    • /business_unitspost
    • /business_unitsget
    • /business_units/{business_unit_uid}get
    • /business_units/{business_unit_uid}put
    • /business_units/{business_unit_uid}/activateput
    • /business_units/reorderput
    • /business_units/{business_unit_uid}del

OTHERS

  • Notes
    • /notesget

Developer Features

  • Webhooks
    • Create a Webhookpost
    • Get Webhooksget
    • Get Webhook Detailsget
    • Update Webhookpost
    • Activate/Deactivate Webhookpost
    • Delete Webhookdel
    • Get Webhooks Historyget
    • Webhook Retrypost

FORM BUILDER

  • Asset Inspection forms
    • Create Inspection formpost
    • Get Inspection form Detailsget
    • Update Asset Inspection Form Fieldput
    • Delete Asset Inspection Form Fielddel
Powered by 

Update Overall Stock

Updated about 1 year ago


Get Product transaction details
Transfer Order
Did this page help you?

Updated about 1 year ago


Get Product transaction details
Transfer Order
Did this page help you?