Upbooks API

Schemas

Upbooks API

Auth
- Login
- RefreshToken
- GetAuthUser
- GetLoginLogs
- GetLoginSessions
- GetOrganizationLoginSessions
- ForgotPasswordByEmail
- UpdatePassword
- ChangePassword
- UpdateProfile
- VerifyEmailToken
- UpdateSelectedOrgDetails
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
- Add
- GetQuickFilters
- GetNextTaskNumber
- GetSingle
- Update
- Delete
- UpdateStatus
- UpdateSortOrder
- UpdatePriority
- UpdateTitle
- UpdateSummary
- UpdateLabels
- UpdateReporter
- UpdateAssignee
- UpdateAttachments
- FileImport
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
Schemas
- Schemas

Schemas

ICommonTax

{
    "taxTreatment": "GST",
    "taxNumber": "string",
    "taxes": [
        {
            "id": "string",
            "name": "string",
            "percentage": 0
        }
    ]
}