GetClientDetail

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

Responses

🟢200Ok

application/json

Body

data

object (ClientDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

name

string

required

clientType

enum<string>

required

Allowed values:

businessindividual

primaryContactId

string | null

optional

billingAddress

optional

shippingAddress

optional

tax

optional

currency

optional

paymentMode

optional

contacts

array[object (IContact) {9}] | null

optional

source

string | null

optional

openingBalance

object | null

optional

notes

string | null

optional

string | null

optional

twitter

string | null

optional

skype

string | null

optional

string | null

optional

instagram

string | null

optional

website

string | null

optional

balance

object | null

optional

syncLedger

optional

clientNumber

string

required

message

string

optional

Example

{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "_id": "string",
    "organizationId": "string",
    "name": "string",
    "clientType": "business",
    "primaryContactId": "string",
    "billingAddress": {
      "locationName": "string",
      "street1": "string",
      "street2": "string",
      "pincode": "string",
      "city": "string",
      "state": "string",
      "country": "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
        }
      ]
    },
    "currency": {
      "name": "string",
      "symbol": "string"
    },
    "paymentMode": "cash",
    "contacts": [
      {
        "isPrimary": true,
        "salutation": "Mr.",
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "workPhone": "string",
        "mobilePhone": "string",
        "designation": "string",
        "department": "string"
      }
    ],
    "source": "string",
    "openingBalance": {
      "currency": {
        "name": "string",
        "symbol": "string"
      },
      "amount": 0
    },
    "notes": "string",
    "fb": "string",
    "twitter": "string",
    "skype": "string",
    "linkedin": "string",
    "instagram": "string",
    "website": "string",
    "balance": {
      "currency": {
        "name": "string",
        "symbol": "string"
      },
      "amount": 0
    },
    "syncLedger": {
      "completed": true,
      "lastSyncDateTime": "2019-08-24T14:15:22Z"
    },
    "clientNumber": "string"
  },
  "message": "string"
}

🟢200Success

Request

Request samples

Responses