UpdateCreditNoteSettings

PATCH

https://api.upbooks.io/api/v1/organization/{id}/settings/credit-note

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

default

object

required

taxesSummary

boolean | null

optional

authorisedSignature

string | null

optional

sendEmail

object | null

optional

creditNoteNumberFormat

string | null

optional

logo

string | null

optional

notes

string | null

optional

terms

string | null

optional

templateType

optional

contact

object | null

optional

name

string | null

optional

Example

{
    "default": {
        "taxesSummary": true,
        "authorisedSignature": "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"
    }
}

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/credit-note' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "default": {
        "taxesSummary": true,
        "authorisedSignature": "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"
    }
}'

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 12:20:20

UpdatePlatformCredits

UpdateDebitNoteSettings