UpdateOrganization - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

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

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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