GetContract - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Query Params

searchText

string

optional

Header Params

pageNo

number <double>

optional

pageSize

number <double>

optional

sortBy

string

optional

Default:

title

sortOrder

number <double>

optional

Default:

1

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.upbooks.io/api/v1/contract?searchText' \
--header 'pageNo;' \
--header 'pageSize;' \
--header 'sortBy;' \
--header 'sortOrder;' \
--header 'ORGANIZATION-ID: 00000'

Responses

🟢200Ok

application/json

Body

data

array[object (IContractDocumentJSON) {10}]

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

title

string

required

client

object (ICommonClient)

required

amount

object

required

status

required

files

array[string] | 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",
            "title": "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
                        }
                    ]
                }
            },
            "amount": {
                "actual": 0,
                "estimated": 0,
                "currency": {
                    "name": "string",
                    "symbol": "string"
                }
            },
            "status": "potential",
            "files": [
                "string"
            ]
        }
    ],
    "totalCount": 0,
    "filteredCount": 0,
    "message": "string"
}