UpdatePreferences - 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

clients

object (IClientModuleNameRequest)

optional

moduleName

string

optional

disabledByOrganization

boolean

optional

ledger

object | null

optional

vendors

object (IVendorModuleNameRequest)

optional

moduleName

string

optional

disabledByOrganization

boolean

optional

ledger

object | null

optional

assets

object (ICommonModuleNameRequest)

optional

moduleName

string

optional

disabledByOrganization

boolean

optional

employees

object (ICommonModuleNameRequest)

optional

expenses

object (ICommonModuleNameRequest)

optional

products

object (ICommonModuleNameRequest)

optional

services

object (ICommonModuleNameRequest)

optional

orders

object (ICommonModuleNameRequest)

optional

payments

object (ICommonModuleNameRequest)

optional

settlements

object (ICommonModuleNameRequest)

optional

invoice

object (ICommonModuleNameRequest)

optional

taxes

object (ITaxesModuleNameRequest)

optional

moduleName

string

optional

disabledByOrganization

boolean

optional

taxPerItem

boolean | null

optional

discounts

object (IDiscountModuleNameRequest)

optional

moduleName

string

optional

disabledByOrganization

boolean

optional

discountPerItem

boolean | null

optional

users

object (ICommonModuleNameRequest)

optional

items

object (ICommonModuleNameRequest)

optional

proposals

object (ICommonModuleNameRequest)

optional

purchaseOrders

object (ICommonModuleNameRequest)

optional

documents

object (ICommonModuleNameRequest)

optional

projects

object (ICommonModuleNameRequest)

optional

tasks

object (ICommonModuleNameRequest)

optional

payroll

object (ICommonModuleNameRequest)

optional

account

object (ICommonModuleNameRequest)

optional

enquiry

object (ICommonModuleNameRequest)

optional

outwardPayments

object (ICommonModuleNameRequest)

optional

creditNotes

object (ICommonModuleNameRequest)

optional

employeeLeaves

object (ICommonModuleNameRequest)

optional

reports

object (ICommonModuleNameRequest)

optional

automatedReminders

object (ICommonModuleNameRequest)

optional

activityLogs

object (ICommonModuleNameRequest)

optional

organizationBackups

object (ICommonModuleNameRequest)

optional

fileImports

object (ICommonModuleNameRequest)

optional

emailRules

object (ICommonModuleNameRequest)

optional

leads

object (ICommonModuleNameRequest)

optional

deals

object (ICommonModuleNameRequest)

optional

debitNotes

object (ICommonModuleNameRequest)

optional

warehouse

object (ICommonModuleNameRequest)

optional

branch

object (ICommonModuleNameRequest)

optional

contracts

object (ICommonModuleNameRequest)

optional

employeeSpends

object (ICommonModuleNameRequest)

optional

Example

{
    "clients": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "ledger": {
            "trigger": "order",
            "enabled": true
        }
    },
    "vendors": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "ledger": {
            "trigger": "purchase-order",
            "enabled": true
        }
    },
    "assets": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employees": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "expenses": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "products": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "services": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "orders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "payments": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "settlements": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "invoice": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "taxes": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "taxPerItem": true
    },
    "discounts": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "discountPerItem": true
    },
    "users": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "items": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "proposals": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "purchaseOrders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "documents": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "projects": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "tasks": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "payroll": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "account": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "enquiry": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "outwardPayments": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "creditNotes": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employeeLeaves": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "reports": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "automatedReminders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "activityLogs": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "organizationBackups": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "fileImports": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "emailRules": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "leads": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "deals": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "debitNotes": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "warehouse": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "branch": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "contracts": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employeeSpends": {
        "moduleName": "string",
        "disabledByOrganization": true
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.upbooks.io/api/v1/organization//settings/preferences' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clients": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "ledger": {
            "trigger": "order",
            "enabled": true
        }
    },
    "vendors": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "ledger": {
            "trigger": "purchase-order",
            "enabled": true
        }
    },
    "assets": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employees": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "expenses": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "products": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "services": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "orders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "payments": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "settlements": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "invoice": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "taxes": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "taxPerItem": true
    },
    "discounts": {
        "moduleName": "string",
        "disabledByOrganization": true,
        "discountPerItem": true
    },
    "users": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "items": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "proposals": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "purchaseOrders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "documents": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "projects": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "tasks": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "payroll": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "account": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "enquiry": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "outwardPayments": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "creditNotes": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employeeLeaves": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "reports": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "automatedReminders": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "activityLogs": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "organizationBackups": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "fileImports": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "emailRules": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "leads": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "deals": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "debitNotes": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "warehouse": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "branch": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "contracts": {
        "moduleName": "string",
        "disabledByOrganization": true
    },
    "employeeSpends": {
        "moduleName": "string",
        "disabledByOrganization": true
    }
}'

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