CalculateProposalTotal

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

items

array [object {4}]

required

taxIds

array[string] | null

optional

discountIds

array[string] | null

optional

newAmount

number <double>

required

quantity

number <double>

required

discountIds

array[string] | null

optional

taxIds

array[string] | null

optional

taxCalculationMode

optional

Any of

TaxCalculationModeEnum

number | null

Allowed values:

before-discountafter-discount

currency

optional

Any of

ICommonCurrency

number | null

name

string

required

symbol

string

required

taxPerItem

boolean

optional

discountPerItem

boolean

optional

Example

{
    "items": [
        {
            "taxIds": [
                "string"
            ],
            "discountIds": [
                "string"
            ],
            "newAmount": 0,
            "quantity": 0
        }
    ],
    "discountIds": [
        "string"
    ],
    "taxIds": [
        "string"
    ],
    "taxCalculationMode": "before-discount",
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "taxPerItem": true,
    "discountPerItem": true
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/proposal/calculate-total' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "items": [
        {
            "taxIds": [
                "string"
            ],
            "discountIds": [
                "string"
            ],
            "newAmount": 0,
            "quantity": 0
        }
    ],
    "discountIds": [
        "string"
    ],
    "taxIds": [
        "string"
    ],
    "taxCalculationMode": "before-discount",
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "taxPerItem": true,
    "discountPerItem": true
}'

Responses

🟢200Ok

application/json

Body

data

object (IProposalCalculateTotalRes)

required

totalAmount

number <double>

required

taxAmount

number <double>

required

discountAmount

number <double>

required

finalAmount

number <double>

required

items

array [object {5}]

required

tax

array[object (ITaxRequest) {11}] | null

optional

discount

array[object (IDiscountRequest) {8}] | null

optional

taxCalculationMode

enum<string>

required

Allowed values:

before-discountafter-discount

message

string

optional

Example

{
    "data": {
        "totalAmount": 0,
        "taxAmount": 0,
        "discountAmount": 0,
        "finalAmount": 0,
        "items": [
            {
                "discount": [
                    {
                        "id": "string",
                        "type": "percentage",
                        "value": 0,
                        "name": "string",
                        "discountCode": "string",
                        "currency": {
                            "name": "string",
                            "symbol": "string"
                        },
                        "sysgenerated": true,
                        "amount": 0
                    }
                ],
                "tax": [
                    {
                        "id": "string",
                        "name": "string",
                        "percentage": 0,
                        "sysgenerated": true,
                        "amount": 0,
                        "currency": {
                            "name": "string",
                            "symbol": "string"
                        },
                        "identifier": "string",
                        "slab": 0,
                        "type": "igst",
                        "taxableAmount": 0,
                        "regions": [
                            "string"
                        ]
                    }
                ],
                "finalAmount": 0,
                "newAmount": 0,
                "quantity": 0
            }
        ],
        "tax": [
            {
                "id": "string",
                "name": "string",
                "percentage": 0,
                "sysgenerated": true,
                "amount": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                },
                "identifier": "string",
                "slab": 0,
                "type": "igst",
                "taxableAmount": 0,
                "regions": [
                    "string"
                ]
            }
        ],
        "discount": [
            {
                "id": "string",
                "type": "percentage",
                "value": 0,
                "name": "string",
                "discountCode": "string",
                "currency": {
                    "name": "string",
                    "symbol": "string"
                },
                "sysgenerated": true,
                "amount": 0
            }
        ],
        "taxCalculationMode": "before-discount"
    },
    "message": "string"
}

🟢200Success