GetAllProposal - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

clientId

string

optional

status

string

optional

searchText

string

optional

fromDate

string <date-time>

optional

toDate

string <date-time>

optional

country

string

optional

currencyName

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

proposalNumber

sortOrder

number <double>

optional

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

array[object (ProposalDocumentJSON) {29}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

proposalNumber

string

required

proposalDate

string <date-time>

required

items

array[object (IOrderItem) {13}]

required

totalAmount

number <double> | null

optional

taxAmount

number <double> | null

optional

discountAmount

number <double> | null

optional

finalAmount

number <double>

required

taxCalculationMode

optional

currency

optional

currencyConversionRate

object (ICommonCurrencyConversionRate)

required

tax

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

optional

discount

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

optional

orderId

string | null

optional

status

enum<string>

required

Allowed values:

draftsentconfirmed

bankAccount

optional

client

object (ICommonClient)

required

proposalFile

string

optional

summary

string | null

optional

enquiry

optional

additional

array [object {2}]

optional

isDeleted

boolean

required

taxPerItem

boolean | null

optional

discountPerItem

boolean | null

optional

taxSummary

boolean | null

optional

totalCount

number <double>

optional

filteredCount

number <double>

optional

message

string

optional

Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "__v": 0,
            "_id": "string",
            "organizationId": "string",
            "proposalNumber": "string",
            "proposalDate": "2019-08-24T14:15:22Z",
            "items": [
                {
                    "name": "string",
                    "amount": 0,
                    "currency": {
                        "name": "string",
                        "symbol": "string"
                    },
                    "quantity": 0,
                    "totalAmount": 0,
                    "taxAmount": 0,
                    "discountAmount": 0,
                    "finalAmount": 0,
                    "hsnCode": "string",
                    "product": {
                        "id": "string",
                        "name": "string",
                        "amount": 0,
                        "hsnCode": "string",
                        "unit": "mm",
                        "currency": {
                            "name": "string",
                            "symbol": "string"
                        },
                        "thumbnail": "string",
                        "productCategories": [
                            {
                                "id": "string",
                                "title": "string",
                                "thumbnail": "string",
                                "description": "string"
                            }
                        ]
                    },
                    "service": {
                        "id": "string",
                        "title": "string",
                        "thumbnail": "string",
                        "paymentType": "one-time",
                        "paymentFrequency": 0,
                        "amount": 0,
                        "hsnCode": "string",
                        "currency": {
                            "name": "string",
                            "symbol": "string"
                        }
                    },
                    "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
                        }
                    ]
                }
            ],
            "totalAmount": 0,
            "taxAmount": 0,
            "discountAmount": 0,
            "finalAmount": 0,
            "taxCalculationMode": "before-discount",
            "currency": {
                "name": "string",
                "symbol": "string"
            },
            "currencyConversionRate": {
                "USD": 0,
                "EUR": 0,
                "GBP": 0,
                "INR": 0,
                "AUD": 0,
                "SGD": 0,
                "CAD": 0,
                "JPY": 0,
                "CNY": 0,
                "SAR": 0,
                "AED": 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
                }
            ],
            "orderId": "string",
            "status": "draft",
            "bankAccount": {
                "title": "string",
                "currency": {
                    "name": "string",
                    "symbol": "string"
                },
                "accountDetails": {
                    "sortCode": "string",
                    "IBANNumber": "string",
                    "swiftCode": "string",
                    "ifscCode": "string",
                    "branch": "string",
                    "bankName": "string",
                    "accountNumber": "string",
                    "name": "string"
                }
            },
            "client": {
                "id": "string",
                "name": "string",
                "clientType": "business",
                "billingAddress": {
                    "locationName": "string",
                    "street1": "string",
                    "street2": "string",
                    "pincode": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string"
                },
                "contacts": [
                    {
                        "isPrimary": true,
                        "salutation": "Mr.",
                        "firstName": "string",
                        "lastName": "string",
                        "email": "string",
                        "workPhone": "string",
                        "mobilePhone": "string",
                        "designation": "string",
                        "department": "string"
                    }
                ],
                "shippingAddress": {
                    "locationName": "string",
                    "street1": "string",
                    "street2": "string",
                    "pincode": "string",
                    "city": "string",
                    "state": "string",
                    "country": "string"
                },
                "tax": {
                    "taxTreatment": "GST",
                    "taxNumber": "string",
                    "taxes": [
                        {
                            "id": "string",
                            "name": "string",
                            "percentage": 0
                        }
                    ]
                }
            },
            "proposalFile": "string",
            "summary": "string",
            "enquiry": {
                "id": "string",
                "enquiryNumber": "string"
            },
            "additional": [
                {
                    "description": "string",
                    "section": "string"
                }
            ],
            "isDeleted": true,
            "taxPerItem": true,
            "discountPerItem": true,
            "taxSummary": true
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}

🟢200Success