Upbooks API
  1. Task
Upbooks API
  • Auth
    • Login
      POST
    • RefreshToken
      POST
    • GetAuthUser
      GET
    • GetLoginLogs
      GET
    • GetLoginSessions
      GET
    • GetOrganizationLoginSessions
      GET
    • ForgotPasswordByEmail
      POST
    • UpdatePassword
      POST
    • ChangePassword
      POST
    • UpdateProfile
      PUT
    • VerifyEmailToken
      POST
    • UpdateSelectedOrgDetails
      PATCH
  • Account Ledger
    • GetAllAccountLedgers
    • RecordAccountLedgerAdjustment
    • FixAccountLedger
    • FixAllAccountLedger
  • Activity Log
    • GetActivityLogs
    • GetAllActivityLogs
  • Announcement
    • GetAnnouncementList
    • AddAnnouncement
    • GetActiveAnnouncements
    • GetAnnouncementDetail
    • UpdateAnnouncement
  • Asset
    • GetAssetsValue
    • GetAssets
    • AddAsset
    • GetAssetDetail
    • UpdateAsset
    • DeleteAsset
    • FileImport
  • Sales
    • GetTotalRevenue
    • GetTotalReceivables
    • GetTotalInwardPayment
    • GetTotalOverDuePayment
    • SalesRatio
    • GetGrowthByMonth
    • GetGrowthByQuarter
    • GetGrowthByYear
    • GetSnapshotReceivables
    • GetSalesByInvoiceTypes
    • GetIncomeByInvoiceTypes
    • GetGstInvoices
    • GetRecurringInvoices
    • GetClientsAcquired
    • GetSalesByMonthGraph
    • GetSalesByYearGraph
    • GetSalesByProductGraph
    • GetSalesByServiceGraph
    • GetSalesByClientGraph
    • GetSalesByCountryGraph
    • GetSalesByUserGraph
    • GetRevenueBySource
    • GetSalesByRegionGraph
  • Client
    • GetClients
    • AddClient
    • GetClientDetail
    • UpdateClient
    • DeleteClient
    • StatementOfAccount
    • LedgerSyncStatus
    • FixStatementOfAccount
    • GetOutstandingReceivables
    • GetTotalBilling
    • UpdateBillingAddress
    • UpdateShippingAddress
    • FileImport
    • GetPrefferedPayment
    • GetPrefferedAcccount
  • Client Ledger
    • RecordClientLedgerAdjustment
  • CreditNote
    • GetCreditNoteList
    • AddCreditNote
    • GetNextCreditNoteNumber
    • GetCreditNoteDetail
    • UpdateCreditNote
    • SendCreditNoteEmail
    • CancelCreditNote
    • UpdateCreditNoteNumber
    • GenerateCreditNote
  • Cron-jobs
    • JobRunner
  • Currency Conversion
    • GetCurrencyRatesData
  • Document
    • GetAllDocumentsOfOrganiztion
    • DeleteFile
  • Discount
    • GetAllDiscounts
    • AddDiscount
    • GetDiscountDetail
    • UpdateDiscount
    • DeleteDiscount
  • Employee
    • GetEmployeesByMonth
    • GetEmployees
    • AddEmployee
    • GetEmployeeDetail
    • UpdateEmployee
    • DeleteEmployee
    • FileImport
    • UpdateSalaryComponent
    • UpdateFileUrl
    • UpdateInvoiceNumber
    • PrepareSalaryComponents
    • UpdateEmployeeName
    • UpdateEmployeeEmail
    • UpdateEmployeePhone
    • UpdateEmployeeDob
    • UpdateEmployeeLocation
    • UpdateEmployeePanNumber
    • UpdateEmployeeAdharNumber
    • UpdateEmployeeEsiNumber
    • UpdateEmployeeEpsNumber
    • UpdateEmployeeUanNumber
    • UpdateEmployeePfNumber
    • UpdateEmployeeCountry
    • UpdateEmployeeBankAccountDetails
    • UpdateEmployeeCurrentAddress
    • UpdateEmployeePermanentAddress
    • LinkUser
    • UpdateEmployeeDocumentInfo
    • UpdateEmployeeProfilePicture
  • Email
    • SendEmail
  • Expense
    • GetMostSpentOn
    • GetTotalRevenue
    • GetExpenseList
    • AddExpense
    • GetExpenseDetail
    • UpdateExpense
    • DeleteExpense
    • UpdateExpenseRecurring
    • UpdateFileUrl
    • FileImport
  • File
    • UploadFile
    • AddFile
  • Hr
    • GetTotalPayroll
    • GetLeastleave
    • GetMostleave
    • GetAssetsValue
    • GetEmployeesByMonth
    • GetEsiEnrolledEmployees
    • GetPfEnrolledEmployees
    • EmployeesLeftByMonth
    • EmployeesByComponentGroup
  • Inventory Ledger
    • GetAllInventoryLedgers
    • RecordInventoryAdjustment
  • Invoice
    • GetInvoiceList
    • AddInvoiceSystemGenerated
    • GetNextInvoiceNumber
    • GetInvoiceDetail
    • UpdateInvoice
    • DeleteInvoice
    • AddInvoiceManual
    • SendInvoiceEmail
    • CancelInvoice
    • UpdateInvoiceNumber
    • UpdateInvoiceRecurring
    • MarkInvoiceAsPaid
    • GenerateInvoice
    • FileImport
  • Item
    • GetAllItems
    • GetItemDetail
    • UpdateItem
  • Organization
    • GetOrganizations
    • AddOrganization
    • UpdateOrganization
    • GetOrganizationDetail
    • DeleteOrganization
    • UpdateOrganizationBusinessProfile
    • ExtendSubscription
    • UpdateGSTDetails
    • UpdateVATDetails
    • UpdateInvoiceOnOrderSetting
    • UpdateReminderSetting
    • UpdateInvoiceSettings
    • UpdatePurchaseOrderSettings
    • UpdateProposalSettings
    • UpdatePreferences
    • GetOrganizationPreferences
    • UpdatePaymentSettings
    • UpdateDefaultPaymentSettings
    • UpdateLogo
    • UpdateFromEmail
    • OrganizationDeactive
    • GetOrganizationSubscriptions
    • GetOrganizationDashboardView
    • GetOrganizationDashboardSnapshot
    • GetSnapshotReceivables
    • DeleteSelectiveData
    • DeletePermanent
    • GetClientCountries
    • GetVendorCountries
    • GetLeadCountries
    • InviteUsers
    • AcceptInvitation
    • UpdatePlatformCredits
    • UpdateCreditNoteSettings
    • UpdateDebitNoteSettings
  • Order
    • GetAllOrder
    • AddOrder
    • GetNextOrderNumber
    • GetOrderItems
    • GetPastDayOrders
    • GetOrderDetail
    • UpdateOrder
    • DeleteOrder
    • CancelOrder
    • CalculateOrderTotal
    • UpdateFileUrl
    • UpdateOrderStatusToDraft
    • FileImport
  • Outward Payment
    • GetAllOutwardPayment
    • AddOutwardPayment
    • GetOutwardPaymentDetail
    • UpdateOutwardPayment
    • DeleteOutwardPayment
    • FileImport
    • UpdateFileUrl
  • Operations
    • GetTotalProjects
    • GetTotalProjectsMultiple
    • GetTotalProjectsBudget
    • GetAllProjectsByClients
    • GetAllProjectsByBudgets
    • GetTasksPrioritySnapshots
    • GetTasksSnapshotGraph
    • GetProjectTaskList
    • GetTasksByProjectList
    • GetTasksList
    • GetProjectsByBudget
  • Payment
    • GetAllPayment
    • AddPayment
    • GetPastDayPayments
    • GetPaymentDetail
    • UpdatePayment
    • DeletePayment
    • GeneratePayment
    • SendPaymentEmail
    • FileImport
    • UpdateFileUrl
  • Product
    • GetProductList
    • AddProduct
    • GetProductDetail
    • UpdateProduct
    • DeleteProduct
    • FileImport
  • Proposal
    • GetAllProposal
    • AddProposal
    • GetNextProposalNumber
    • GetProposalDetail
    • UpdateProposal
    • DeleteProposal
    • CalculateProposalTotal
    • GenerateProposal
  • Platform Plan
    • GetAllPlatformPlans
    • AddPlatformPlan
    • GetPlatformPlanDetail
    • UpdatePlatformPlan
    • DeletePlatformPlan
  • Platform Subscription
    • GetAllPlatformSubscriptions
    • AddPlatformPayment
  • Platform Payment
    • GetAllPlatformPayments
    • GetPlatformPaymentDetail
    • CancelPlatformPayment
  • ProductCategory
    • GetAllProductCategories
    • AddProductCategory
    • GetProductCategoryDetail
    • UpdateProductCategory
    • DeleteProductCategory
  • Purchase Order
    • GetOrderItems
    • GetAllPurchaseOrder
    • AddPurchaseOrder
    • GetNextPurchaseOrderNumber
    • GetPurchaseOrderDetail
    • UpdatePurchaseOrder
    • DeletePurchaseOrder
    • CalculatePurchaseOrderTotal
    • GeneratePurchaseOrder
  • Purchase
    • GetMostSpentOn
    • GetTotalExpense
    • GetTotalOutwardPayment
    • GetExpenseByTypeGraph
    • GetGstExpenses
    • GetUnpaidExpenses
    • GetOutwardPayments
    • GetExpenseBreakdownByVendorGraph
    • GetExpenseBreakdownByTypeGraph
    • GetExpenseWithoutReciepts
  • Recurring Expense
    • GetAllRecurringExpenses
    • GetRecurringExpenseDetail
    • UpdateRecurringExpenseStatus
    • UpdateRecurringExpenseNextDue
  • Recurring Invoice
    • GetAllRecurringInvoices
    • GetRecurringInvoiceDetail
    • UpdateRecurringInvoiceStatus
    • DeleteRecurringInvoice
    • UpdateRecurringInvoiceNextDue
  • Report
    • GetSalesByClient
    • GetSalesByProduct
    • GetSalesByProductCategory
    • GetSalesByService
    • GetSalesByMonth
    • GetSalesByYear
    • GetSalesByQuarter
    • GetSalesByCountry
    • GetTaxSummary
    • GetInvoiceDetailReport
    • GetExpensesByMonth
    • GetProfitAndLossReportV2
    • GetBalanceSheetReport
    • GetTrialBalanceReport
    • GetGeneralLedger
    • GetSalesByHsn
    • GetTaxesByMonth
    • GetOtherSales
  • Routes
    • GetRoutes
    • AddRoute
    • GetRouteDetail
    • UpdateRoute
    • DeleteRoute
  • Settlement
    • GetAllSettlements
    • GetAllSettlementsSuperadmin
    • GetSettlementDetail
  • Services
    • GetAllServices
    • AddServices
    • GetServicesDetail
    • UpdateServices
    • DeleteServices
    • FileImport
  • Tax
    • GetAllTaxes
    • AddTax
    • GetTaxDetail
    • UpdateTax
    • DeleteTax
    • FileImport
  • Trip
    • GetTrips
    • AddTrip
    • GetTripDetail
    • UpdateTrip
    • DeleteTrip
  • User
    • GetUser
    • GetUserDetail
    • UpdateUser
    • DeleteUser
    • AddUserOnboarding
    • GetOrganizationByUser
    • UpdateEmailOfUser
    • UpdateImageOfUser
    • RemoveUserOrganization
    • UpdateOrganizationActive
  • User Invites
    • GetUserInviteList
    • CancelUserInvite
  • Vendor
    • GetAllVendors
    • AddVendor
    • GetVendorDetail
    • UpdateVendor
    • DeleteVendor
    • GetOutstandingPayables
    • GetTotalBilling
    • StatementOfAccount
    • LedgerSyncStatus
    • FixStatementOfAccount
    • FileImport
  • Vendor Ledger
    • RecordVendorLedgerAdjustment
  • Projects
    • GetAllProjects
    • AddProject
    • GetProjectDetail
    • UpdateProjects
    • DeleteProject
    • FileImport
    • UpdateProjectIcon
    • UpdateProjectStatus
    • UpdateProjectArchiveStatus
  • Pre Sales
    • GetLeadsBySource
    • GetLeadsByMonthGraph
    • GetRecentEnquires
  • Task
    • Get
      GET
    • Add
      POST
    • GetQuickFilters
      GET
    • GetNextTaskNumber
      GET
    • GetSingle
      GET
    • Update
      PUT
    • Delete
      DELETE
    • UpdateStatus
      PATCH
    • UpdateSortOrder
      PATCH
    • UpdatePriority
      PATCH
    • UpdateTitle
      PATCH
    • UpdateSummary
      PATCH
    • UpdateLabels
      PATCH
    • UpdateReporter
      PATCH
    • UpdateAssignee
      PATCH
    • UpdateAttachments
      PATCH
    • FileImport
      POST
  • Payroll
    • GetTotalPayroll
    • GetAllPayroll
    • AddPayroll
    • PrepareEmployeePayroll
    • GetSinglePayroll
    • UpdatePayroll
    • DeletePayroll
    • GeneratePayroll
    • FileImport
  • Account
    • Get
    • AddAccount
    • GetSingle
    • Update
    • Delete
    • FileImport
    • LedgerSyncStatus
    • CloseBooks
  • Enquiry
    • GetAllEnquiries
    • AddEnquiry
    • GetEnquiryDetail
    • UpdateEnquiry
    • DeleteExpense
  • Account Transfer
    • GetAccountTransfers
    • AddAccountTransfer
    • GetAccountTransferDetail
    • DeleteAccountTransfer
    • FileImport
  • File Import
    • Get
  • File Import Error
    • GetFileImportErrorList
  • Brand
    • GetAllBrands
    • AddBrand
    • GetBrandListPublic
    • GetBrandDetail
    • UpdateBrand
    • DeleteBrand
  • Salary Component
    • GetAllSalaryComponents
    • AddSalaryComponent
    • GetSalaryComponent
    • UpdateSalaryComponent
    • DeleteSalaryComponent
  • Leaves Configuration
    • CreateLeave
    • GetLeaves
    • DeleteLeave
    • UpdateLeave
    • GetLeave
  • Tax Calendar
    • CreateTaxCalendar
    • GetTaxCalendar
    • DeleteTaxCalendar
    • UpdateTaxCalendar
    • GetLeave
  • Contract
    • CreateContract
    • GetContract
    • DeleteContract
    • UpdateContract
    • GetLeave
  • GST-Reports
    • GetReportB2B
    • GetReportB2cl
    • GetReportB2cs
    • GetReportExports
    • GetGstSummary
    • ExportJsonGst1
  • Organization Backup
    • GetAllBackups
    • AddOrganizationBackup
  • Bank Account
    • AddBankAccount
    • GetAllBankAccounts
    • GetBankAccountDetail
    • UpdateBankAccount
    • DeleteBankAccount
    • FileImport
  • Leave Policy
    • GetAllBankAccounts
    • AddLeavePolicy
    • GetLeavePolicyDetail
    • UpdateLeavePolicy
    • DeleteLeavePolicy
  • Leave Application
    • GetMostleave
    • GetLeastleave
    • GetAllLeaveApplications
    • AddLeaveApplication
    • GetLeaveApplicationDetail
    • DeleteLeaveApplication
    • UpdateLeaveApplication
    • GetEmployeeLeaveSummary
    • UpdateLeaveApplicationStatus
    • UpdateLeaveApplicationStatusFromEmail
  • Backup Restore
    • AddBackupRestore
    • GetAllBackupRestores
  • Finance
    • GetGstReceivableTotal
    • GetGstReceivable
    • GetGstPayableTotal
    • GetGstPayable
    • GetAccountBalance
    • GetLastAccountDebited
    • GetAccountTransferSummary
    • GetRecentTransfer
    • GetCreditedAmounts
    • GetDebitedAmounts
    • GetGstBills
    • GetAccountAnalysisGraph
  • Email-Rule
    • GetEmailRules
    • AddEmailRule
    • UpdateEmailRule
    • DeleteEmailRule
  • Widget
    • GetWidgets
  • User Dashboard
    • GetUserDashboards
    • Add
    • Update
  • ExpenseCategory
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • Lead
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
    • LeadToClient
    • FileImport
  • LeadActivity
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • Deal
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • DebitNote
    • GetDebitNoteList
    • AddDebitNote
    • GetNextDebitNoteNumber
    • GetDebitNoteDetail
    • UpdateDebitNote
    • SendDebitNoteEmail
    • CancelDebitNote
    • UpdateDebitNoteNumber
    • GenerateDebitNote
  • SpendCategory
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • SpendPolicy
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • Employee Spend
    • GetAllEmployeeSpends
    • AddEmployeeSpend
    • GetEmployeeSpendDetail
    • DeleteEmployeeSpend
    • UpdateEmployeeSpend
  • Warehouse
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  • Branch
    • Get
    • Add
    • GetSingle
    • Update
    • Delete
  1. Task

GetSingle

GET
https://api.upbooks.io/api/v1/task/{id}
Task

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
id
string 
required
Header Params
ORGANIZATION-ID
string 
optional
OrganizationId of your registered business on upbooks
Example:
00000

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.upbooks.io/api/v1/task/' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok
application/json
Body
data
object (TaskDocumentJSON) 
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
__v
number <double>
optional
_id
string 
required
organization
object (ICommonOrganization) 
required
taskNumber
string  | null 
required
reporter
object  | null 
optional
assignee
object  | null 
optional
parentTask
object  | null 
optional
priority
number <double> | null 
optional
labels
array[string] | null 
optional
dueDate
string <date-time> | null 
optional
startDate
string <date-time> | null 
optional
endDate
string <date-time> | null 
optional
title
string  | null 
required
summary
string  | null 
optional
sortOrder
number <double> | null 
optional
time
object  | null 
optional
attachments
array[object (ICommonAttachments) {2}]  | null 
optional
status
enum<string> 
required
Allowed values:
pendingstartedcompletedcancelled
project
optional
isDeleted
boolean 
required
message
string 
optional
Example
{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organization": {
            "id": "string",
            "organizationId": "string",
            "name": "string",
            "state": "string"
        },
        "taskNumber": "string",
        "reporter": {
            "type": "organization-admin",
            "email": "string",
            "name": "string",
            "id": "string"
        },
        "assignee": {
            "type": "organization-admin",
            "email": "string",
            "name": "string",
            "id": "string"
        },
        "parentTask": {
            "assignee": {
                "type": "organization-admin",
                "email": "string",
                "name": "string",
                "id": "string"
            },
            "title": "string",
            "taskNumber": "string",
            "id": "string"
        },
        "priority": 0,
        "labels": [
            "string"
        ],
        "dueDate": "2019-08-24T14:15:22Z",
        "startDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "title": "string",
        "summary": "string",
        "sortOrder": 0,
        "time": {
            "actual": 0,
            "estimated": 0
        },
        "attachments": [
            {
                "title": "string",
                "url": "string"
            }
        ],
        "status": "pending",
        "project": {
            "id": "string",
            "title": "string",
            "projectKey": "string"
        },
        "isDeleted": true
    },
    "message": "string"
}
🟢200Success
Previous
GetNextTaskNumber
Next
Update
Built with