CancelDebitNote

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

Responses

🟢200Ok

application/json

Body

data

object (DebitNoteDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

debitNoteNumber

string

required

expenses

array[object (IExpenseDebitNote) {7}]

required

items

array[object (IOrderItem) {13}]

required

vendor

object (ICommonVendor)

required

referenceNumber

string | null

optional

date

string <date-time>

required

dateTime

string <date-time>

required

debitNoteFile

string | null

optional

debitNoteStaticFile

string | null

optional

status

enum<string>

required

Allowed values:

draftconfirmedsentcancelled

currency

object (ICommonCurrency)

required

currencyConversionRate

object (ICommonCurrencyConversionRate)

required

finalAmount

number <double>

required

totalAmount

number <double>

required

taxAmount

number <double>

required

terms

string | null

optional

notes

string | null

optional

notification

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

optional

taxes

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

optional

taxPerItem

boolean | null

optional

discountPerItem

boolean | null

optional

taxSummary

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",
    "debitNoteNumber": "string",
    "expenses": [
      {
        "id": "string",
        "date": "2019-08-24T14:15:22Z",
        "expenseNumber": "string",
        "purchaseOrderNumber": "string",
        "amount": 0,
        "type": "string",
        "currency": {
          "name": "string",
          "symbol": "string"
        }
      }
    ],
    "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
          }
        ]
      }
    ],
    "vendor": {
      "id": "string",
      "name": "string",
      "address": {
        "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"
        }
      ],
      "tax": {
        "taxTreatment": "GST",
        "taxNumber": "string",
        "taxes": [
          {
            "id": "string",
            "name": "string",
            "percentage": 0
          }
        ]
      }
    },
    "referenceNumber": "string",
    "date": "2019-08-24T14:15:22Z",
    "dateTime": "2019-08-24T14:15:22Z",
    "debitNoteFile": "string",
    "debitNoteStaticFile": "string",
    "status": "draft",
    "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
    },
    "finalAmount": 0,
    "totalAmount": 0,
    "taxAmount": 0,
    "terms": "string",
    "notes": "string",
    "notification": [
      {
        "type": "string",
        "mode": "string",
        "sentOn": "2019-08-24T14:15:22Z",
        "to": "string",
        "cc": [
          "string"
        ],
        "bcc": [
          "string"
        ],
        "subject": "string"
      }
    ],
    "taxes": [
      {
        "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"
        ]
      }
    ],
    "taxPerItem": true,
    "discountPerItem": true,
    "taxSummary": true,
    "error": [
      {
        "code": "string",
        "title": "string",
        "dateTime": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "message": "string"
}

🟢200Success

Request

Request samples

Responses