CancelOrder - Upbooks API

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:

00000

Body Params application/json

object (ICommonSendEmailRequest)

required

enabled

boolean

required

optional

array[string] | null

optional

bcc

array[string] | null

optional

subject

string | null

optional

body

string | null

optional

sendOrderDocuments

boolean | null

optional

Example

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Ok

application/json

Body

data

object (OrderDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

orderNumber

string

required

orderDate

string <date-time>

required

dateTime

string <date-time>

required

items

array[object (IOrderItem) {13}]

required

totalAmount

number <double>

required

taxAmount

number <double>

required

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

invoices

array[object (IOrderInvoices) {5}] | null

optional

status

enum<string>

required

Allowed values:

draftconfirmedinvoicedpartially-paidpaidcancelledpartially-invoicedupdated

isDeleted

boolean

required

client

object (ICommonClient)

required

poNumber

string | null

optional

salesPerson

array[object (ICommonEmployee) {7}] | null

optional

miscFiles

array[string] | null

optional

bankAccount

optional

paidDate

string <date-time> | null

optional

taxPerItem

boolean | null

optional

discountPerItem

boolean | null

optional

error

array[object (ICommonErrors) {3}] | null

optional

message

string

optional

Example

{
  "data": {
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0,
    "_id": "string",
    "organizationId": "string",
    "orderNumber": "string",
    "orderDate": "2019-08-24T14:15:22Z",
    "dateTime": "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
      }
    ],
    "invoices": [
      {
        "invoiceNumber": "string",
        "invoiceId": "string",
        "invoicedAmount": 0,
        "invoiceDate": "2019-08-24T14:15:22Z",
        "paidAmount": 0
      }
    ],
    "status": "draft",
    "isDeleted": true,
    "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
          }
        ]
      }
    },
    "poNumber": "string",
    "salesPerson": [
      {
        "id": "string",
        "name": "string",
        "employeeNumber": "string",
        "email": "string",
        "phone": "string",
        "type": "full-time",
        "employment": [
          {
            "id": "string",
            "isCurrent": true,
            "dateOfJoining": "2019-08-24T14:15:22Z",
            "dateOfLeaving": "2019-08-24T14:15:22Z",
            "specialSchemes": [
              {
                "enabled": true,
                "name": "ESI"
              }
            ],
            "salary": {
              "componentGroup": {
                "id": "string",
                "groupName": "string",
                "salaryCalculationMode": "month-days",
                "sandwichLeaves": true
              },
              "type": "hourly",
              "ctc": 0,
              "gross": 0,
              "net": 0,
              "currency": {
                "name": "string",
                "symbol": "string"
              },
              "components": [
                {
                  "name": "string",
                  "code": "BASIC",
                  "type": "EARNINGS",
                  "isTaxable": true,
                  "isAttendanceBased": true,
                  "isIncludedInCTC": true,
                  "isActive": true,
                  "_id": "string",
                  "value": {
                    "amount": 0,
                    "currency": {
                      "name": "string",
                      "symbol": "string"
                    }
                  },
                  "formula": "string",
                  "custom": true,
                  "salaryComponentId": "string",
                  "amount": 0
                }
              ]
            },
            "designation": "string",
            "role": "string",
            "supervisor": {},
            "leavePolicies": [
              {
                "id": "string",
                "name": "string",
                "leaves": [
                  {
                    "type": "string",
                    "probationPeriod": 0,
                    "noOfLeaves": 0,
                    "monthlyLimit": 0
                  }
                ]
              }
            ],
            "spendPolicies": [
              {
                "id": "string",
                "title": "string"
              }
            ]
          }
        ]
      }
    ],
    "miscFiles": [
      "string"
    ],
    "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"
      }
    },
    "paidDate": "2019-08-24T14:15:22Z",
    "taxPerItem": true,
    "discountPerItem": true,
    "error": [
      {
        "code": "string",
        "title": "string",
        "dateTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "message": "string"
}

🟢200Success