UpdateInvoiceSettings

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

type

enum<string>

required

Allowed values:

manualsystem-generated

recurring

optional

Any of

ICommonEnabledLimit

number | null

enabled

boolean

required

limit

number <double> | null

optional

limitType

optional

limitFrequency

optional

addOn

object | null

optional

generateInvoiceOnOrder

boolean | null

optional

resetSequenceOnNewFiscalYear

boolean

required

default

object

required

taxesSummary

boolean | null

optional

authorisedSignature

string | null

optional

invoiceTemplate

optional

paymentMode

object | null

optional

tax

object | null

optional

sendEmail

object | null

optional

invoiceNumberFormat

string | null

optional

contact

object | null

optional

dueInDays

number <double> | null

optional

logo

string | null

optional

name

string | null

optional

notes

string | null

optional

terms

string | null

optional

Example

{
    "type": "manual",
    "recurring": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    },
    "generateInvoiceOnOrder": true,
    "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"
    }
}

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/invoice' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "manual",
    "recurring": {
        "enabled": true,
        "limit": 0,
        "limitType": "count",
        "limitFrequency": "total",
        "addOn": {
            "per": "count",
            "price": 0,
            "allowed": true
        }
    },
    "generateInvoiceOnOrder": true,
    "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"
    }
}'

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