- Auth
- Account Ledger
- Activity Log
- Announcement
- Asset
- 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
- Client Ledger
- CreditNote
- Cron-jobs
- Currency Conversion
- Document
- Discount
- 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
- Expense
- File
- Hr
- Inventory Ledger
- Invoice
- Item
- Organization
- GetOrganizationsGET
- AddOrganizationPOST
- UpdateOrganizationPUT
- GetOrganizationDetailGET
- DeleteOrganizationDELETE
- UpdateOrganizationBusinessProfilePATCH
- ExtendSubscriptionPATCH
- UpdateGSTDetailsPATCH
- UpdateVATDetailsPATCH
- UpdateInvoiceOnOrderSettingPATCH
- UpdateReminderSettingPATCH
- UpdateInvoiceSettingsPATCH
- UpdatePurchaseOrderSettingsPATCH
- UpdateProposalSettingsPATCH
- UpdatePreferencesPATCH
- GetOrganizationPreferencesGET
- UpdatePaymentSettingsPATCH
- UpdateDefaultPaymentSettingsPATCH
- UpdateLogoPATCH
- UpdateFromEmailPATCH
- OrganizationDeactivePATCH
- GetOrganizationSubscriptionsGET
- GetOrganizationDashboardViewGET
- GetOrganizationDashboardSnapshotGET
- GetSnapshotReceivablesGET
- DeleteSelectiveDataDELETE
- DeletePermanentDELETE
- GetClientCountriesGET
- GetVendorCountriesGET
- GetLeadCountriesGET
- InviteUsersPOST
- AcceptInvitationGET
- UpdatePlatformCreditsPATCH
- UpdateCreditNoteSettingsPATCH
- UpdateDebitNoteSettingsPATCH
- Order
- Outward Payment
- Operations
- Payment
- Product
- Proposal
- Platform Plan
- Platform Subscription
- Platform Payment
- ProductCategory
- Purchase Order
- Purchase
- Recurring Expense
- Recurring Invoice
- Report
- GetSalesByClient
- GetSalesByProduct
- GetSalesByProductCategory
- GetSalesByService
- GetSalesByMonth
- GetSalesByYear
- GetSalesByQuarter
- GetSalesByCountry
- GetTaxSummary
- GetInvoiceDetailReport
- GetExpensesByMonth
- GetProfitAndLossReportV2
- GetBalanceSheetReport
- GetTrialBalanceReport
- GetGeneralLedger
- GetSalesByHsn
- GetTaxesByMonth
- GetOtherSales
- Routes
- Settlement
- Services
- Tax
- Trip
- User
- User Invites
- Vendor
- Vendor Ledger
- Projects
- Pre Sales
- Task
- Payroll
- Account
- Enquiry
- Account Transfer
- File Import
- File Import Error
- Brand
- Salary Component
- Leaves Configuration
- Tax Calendar
- Contract
- GST-Reports
- Organization Backup
- Bank Account
- Leave Policy
- Leave Application
- Backup Restore
- Finance
- Email-Rule
- Widget
- User Dashboard
- ExpenseCategory
- Lead
- LeadActivity
- Deal
- DebitNote
- SpendCategory
- SpendPolicy
- Employee Spend
- Warehouse
- Branch
UpdateOrganization
PUT
https://api.upbooks.io/api/v1/organization/{id}
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
Example:
000000
Body Params application/json
name
stringÂ
required
location
stringÂ
required
state
stringÂ
required
regionalSetting
object (IRegionalSetting)Â
required
currency
object (ICommonCurrency)Â
required
language
stringÂ
required
timeZone
stringÂ
required
logo
string  | nullÂ
optional
taxSettings
array[object (IOrgTaxSettings) {3}]  | nullÂ
optional
treatment
stringÂ
required
identificationName
stringÂ
required
identificationNumber
stringÂ
required
fiscalYear
object  | nullÂ
optional
to
number <double> | nullÂ
optional
from
number <double> | nullÂ
optional
settings
object (IOrganizationSettings)Â
required
clients
object (IClientSettings)Â
required
vendors
object (IVendorSettings)Â
required
assets
object (IAssetSettings)Â
required
employees
object (IEmployeeSettings)Â
required
expenses
object (IExpenseSettings)Â
required
products
object (IProductSettings)Â
required
services
object (IServiceSettings)Â
required
orders
object (IOrderSettings)Â
required
payments
object (IPaymentSettings)Â
required
settlements
object (ISettlementSettings)Â
required
invoice
object (IInvoiceSettings)Â
required
taxes
object (ITaxSettings)Â
required
discounts
object (IDiscountSettings)Â
required
users
object (IUserSettings)Â
required
items
object (IItemSettings)Â
required
proposals
object (IProposalSettings)Â
required
purchaseOrders
object (IPurchaseOrderSettings)Â
required
documents
object (IDocumentSettings)Â
required
projects
object (IProjectSettings)Â
required
tasks
object (ITaskSettings)Â
required
payroll
object (IPayrollSettings)Â
required
account
object (IAccountSettings)Â
required
enquiry
object (IEnquirySettings)Â
required
outwardPayments
object (IOutwardPaymentSettings)Â
required
creditNotes
object (ICreditNoteSettings)Â
required
employeeLeaves
object (IEmployeeLeaveSettings)Â
required
reports
object (IReportSettings)Â
required
automatedReminders
object (IAutomatedReminderSettings)Â
required
activityLogs
object (IActivityLogSettings)Â
required
fileImports
object (IFileImportSettings)Â
required
organizationBackups
object (IOrganizationBackupSettings)Â
required
emailRules
object (IEmailRuleSettings)Â
required
leads
object (ILeadSettings)Â
required
deals
object (IDealSettings)Â
required
debitNotes
object (IDebitNoteSettings)Â
required
warehouse
object (IWarehouseSettings)Â
required
branch
object (IBranchSettings)Â
required
contracts
object (IContractSettings)Â
required
employeeSpends
object (IEmployeeSpendSettings)Â
required
dynamicDashboard
object (IDynamicDashboardSettings)Â
required
apiKeys
object (IApiKeySettings)Â
required
businessSettings
object  | nullÂ
optional
industry
string  | nullÂ
optional
TAN
string  | nullÂ
optional
PAN
string  | nullÂ
optional
CIN
string  | nullÂ
optional
vatRegistered
boolean  | nullÂ
optional
gstRegistered
boolean  | nullÂ
optional
organizationType
enum<string>Â
optional
Allowed values:
individualbusiness
phone
object (IPhone)Â
optional
code
stringÂ
optional
number
stringÂ
optional
Example
{
"name": "string",
"location": "string",
"state": "string",
"regionalSetting": {
"currency": {
"name": "string",
"symbol": "string"
},
"language": "string",
"timeZone": "string"
},
"logo": "string",
"taxSettings": [
{
"treatment": "string",
"identificationName": "string",
"identificationNumber": "string"
}
],
"fiscalYear": {
"to": 0,
"from": 0
},
"settings": {
"clients": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"ledger": {
"trigger": "order",
"enabled": true
}
},
"vendors": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"ledger": {
"trigger": "purchase-order",
"enabled": true
}
},
"assets": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"employees": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"expenses": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"recurring": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
}
},
"disabledByOrganization": true
},
"products": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"updatedByOrganization": true,
"disabledByOrganization": true
},
"services": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"updatedByOrganization": true,
"disabledByOrganization": true
},
"orders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"payments": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"gateway": {
"razorpay": {
"fee": {
"settlement": {
"value": 0,
"feeType": "flat"
},
"transaction": {
"value": 0,
"feeType": "flat"
}
},
"account": {
"bankAccount": {
"accountNumber": "string",
"accountType": "string",
"beneficiaryName": "string",
"ifscCode": "string"
},
"accountDetails": {
"businessType": "string",
"businessName": "string"
},
"tncAcceptedIPAdress": "string",
"tncAcceptedAt": "2019-08-24T14:15:22Z",
"tncAccepted": true,
"email": "string",
"name": "string",
"rzpLinkedAccountId": "string"
},
"mode": "self",
"enabled": true
}
},
"moduleName": "string",
"default": {
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"logo": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"settlements": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"invoice": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"recurring": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
}
},
"type": "manual",
"generateInvoiceOnOrder": true,
"reminderSettings": [
{
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"type": "first",
"dueAfter": 0
}
],
"resetSequenceOnNewFiscalYear": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"invoiceTemplate": "template1",
"paymentMode": {
"wireTransfer": {
"account": {
"title": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"accountDetails": {
"sortCode": "string",
"IBANNumber": "string",
"swiftCode": "string",
"ifscCode": "string",
"branch": "string",
"bankName": "string",
"accountNumber": "string",
"name": "string"
}
},
"enabled": true
},
"gateway": {
"razorpay": {
"description": "string",
"enabled": true
}
},
"cash": {
"description": "string",
"enabled": true
}
},
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"invoiceNumberFormat": "string",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"dueInDays": 0,
"logo": "string",
"name": "string",
"notes": "string",
"terms": "string"
},
"moduleName": "string",
"disabledByOrganization": true
},
"taxes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"taxPerItem": true
},
"discounts": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"discountPerItem": true
},
"users": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"items": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"proposals": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"default": {
"authorisedSignature": "string",
"proposalNumberFormat": "string",
"name": "string",
"notes": "string",
"terms": "string",
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"taxesSummary": true,
"logo": "string",
"phone": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"purchaseOrders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"default": {
"authorisedSignature": "string",
"purchaseOrderNumberFormat": "string",
"name": "string",
"notes": "string",
"terms": "string",
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"taxesSummary": true,
"logo": "string",
"phone": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"documents": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"projects": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"tasks": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"payroll": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"account": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"enquiry": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"outwardPayments": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"creditNotes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"creditNoteNumberFormat": "string",
"logo": "string",
"notes": "string",
"terms": "string",
"templateType": "template1",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"name": "string"
}
},
"employeeLeaves": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"reports": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"automatedReminders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"activityLogs": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"fileImports": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"organizationBackups": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"emailRules": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"leads": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"deals": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"debitNotes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"debitNoteNumberFormat": "string",
"logo": "string",
"notes": "string",
"terms": "string",
"templateType": "template1",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"name": "string"
}
},
"warehouse": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"branch": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"contracts": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"employeeSpends": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"dynamicDashboard": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"apiKeys": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
}
},
"businessSettings": {
"industry": "string",
"TAN": "string",
"PAN": "string",
"CIN": "string",
"vatRegistered": true,
"gstRegistered": true
},
"organizationType": "individual",
"phone": {
"code": "string",
"number": "string"
}
}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 PUT 'https://api.upbooks.io/api/v1/organization/' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "string",
"location": "string",
"state": "string",
"regionalSetting": {
"currency": {
"name": "string",
"symbol": "string"
},
"language": "string",
"timeZone": "string"
},
"logo": "string",
"taxSettings": [
{
"treatment": "string",
"identificationName": "string",
"identificationNumber": "string"
}
],
"fiscalYear": {
"to": 0,
"from": 0
},
"settings": {
"clients": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"ledger": {
"trigger": "order",
"enabled": true
}
},
"vendors": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"ledger": {
"trigger": "purchase-order",
"enabled": true
}
},
"assets": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"employees": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"expenses": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"recurring": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
}
},
"disabledByOrganization": true
},
"products": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"updatedByOrganization": true,
"disabledByOrganization": true
},
"services": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"updatedByOrganization": true,
"disabledByOrganization": true
},
"orders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"payments": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"gateway": {
"razorpay": {
"fee": {
"settlement": {
"value": 0,
"feeType": "flat"
},
"transaction": {
"value": 0,
"feeType": "flat"
}
},
"account": {
"bankAccount": {
"accountNumber": "string",
"accountType": "string",
"beneficiaryName": "string",
"ifscCode": "string"
},
"accountDetails": {
"businessType": "string",
"businessName": "string"
},
"tncAcceptedIPAdress": "string",
"tncAcceptedAt": "2019-08-24T14:15:22Z",
"tncAccepted": true,
"email": "string",
"name": "string",
"rzpLinkedAccountId": "string"
},
"mode": "self",
"enabled": true
}
},
"moduleName": "string",
"default": {
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"logo": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"settlements": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"invoice": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"recurring": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
}
},
"type": "manual",
"generateInvoiceOnOrder": true,
"reminderSettings": [
{
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"type": "first",
"dueAfter": 0
}
],
"resetSequenceOnNewFiscalYear": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"invoiceTemplate": "template1",
"paymentMode": {
"wireTransfer": {
"account": {
"title": "string",
"currency": {
"name": "string",
"symbol": "string"
},
"accountDetails": {
"sortCode": "string",
"IBANNumber": "string",
"swiftCode": "string",
"ifscCode": "string",
"branch": "string",
"bankName": "string",
"accountNumber": "string",
"name": "string"
}
},
"enabled": true
},
"gateway": {
"razorpay": {
"description": "string",
"enabled": true
}
},
"cash": {
"description": "string",
"enabled": true
}
},
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"invoiceNumberFormat": "string",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"dueInDays": 0,
"logo": "string",
"name": "string",
"notes": "string",
"terms": "string"
},
"moduleName": "string",
"disabledByOrganization": true
},
"taxes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"taxPerItem": true
},
"discounts": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"discountPerItem": true
},
"users": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"items": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"proposals": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"default": {
"authorisedSignature": "string",
"proposalNumberFormat": "string",
"name": "string",
"notes": "string",
"terms": "string",
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"taxesSummary": true,
"logo": "string",
"phone": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"purchaseOrders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"default": {
"authorisedSignature": "string",
"purchaseOrderNumberFormat": "string",
"name": "string",
"notes": "string",
"terms": "string",
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"taxesSummary": true,
"logo": "string",
"phone": "string",
"email": "string",
"templateType": "template1"
},
"disabledByOrganization": true
},
"documents": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"projects": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"tasks": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"payroll": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"account": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"enquiry": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"outwardPayments": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"creditNotes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"creditNoteNumberFormat": "string",
"logo": "string",
"notes": "string",
"terms": "string",
"templateType": "template1",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"name": "string"
}
},
"employeeLeaves": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"reports": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"automatedReminders": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"activityLogs": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"fileImports": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"organizationBackups": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"emailRules": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"leads": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"deals": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"debitNotes": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true,
"default": {
"taxesSummary": true,
"authorisedSignature": "string",
"tax": {
"taxNumber": "string",
"taxTreatment": "string"
},
"sendEmail": {
"subject": "string",
"bccEmails": [
"string"
],
"ccEmails": [
"string"
],
"enabled": true
},
"debitNoteNumberFormat": "string",
"logo": "string",
"notes": "string",
"terms": "string",
"templateType": "template1",
"contact": {
"email": "string",
"phone": "string",
"address": "string"
},
"name": "string"
}
},
"warehouse": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"branch": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"contracts": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"employeeSpends": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"dynamicDashboard": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
},
"apiKeys": {
"enabled": true,
"limit": 0,
"limitType": "count",
"limitFrequency": "total",
"addOn": {
"per": "count",
"price": 0,
"allowed": true
},
"moduleName": "string",
"disabledByOrganization": true
}
},
"businessSettings": {
"industry": "string",
"TAN": "string",
"PAN": "string",
"CIN": "string",
"vatRegistered": true,
"gstRegistered": true
},
"organizationType": "individual",
"phone": {
"code": "string",
"number": "string"
}
}'Responses
🟢200Ok
application/json
Body
data
object (OrganizationDocumentJSON)Â
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
__v
number <double>
optional
_id
stringÂ
required
name
stringÂ
required
organizationId
stringÂ
required
location
stringÂ
required
state
stringÂ
required
logo
string  | nullÂ
optional
regionalSetting
object (IRegionalSetting)Â
required
taxSettings
array[object (IOrgTaxSettings) {3}]  | nullÂ
optional
userId
stringÂ
required
settings
object (IOrganizationSettings)Â
required
fromEmail
stringÂ
optional
fiscalYear
objectÂ
optional
businessSettings
object  | nullÂ
optional
isDeactivated
booleanÂ
optional
platformCredits
object (IOrganizationPlatformCredits)Â
optional
registrationSource
enum<string>Â
optional
Allowed values:
upbooks-webupbooks-android-appupbooks-ios-appupbooks-expense-webupbooks-expense-android-appupbooks-expense-ios-app
organizationType
enum<string>Â
optional
Allowed values:
individualbusiness
phone
object (IPhone)Â
optional
message
stringÂ
optional
Example
🟢200Success
Modified at 2024-04-09 11:37:53