Fetch All Debit Notes

GET

/apis/external/vendor/debitNote/getAllDebitNotes

GET

/apis/external/vendor/debitNote/getAllDebitNotes

curl -G https://heimdall.eka.io/apis/external/vendor/debitNote/getAllDebitNotes \
     -H "DICE-APP-ID: {{Company Code}}" \
     -H "X-CLIENT-ID: {{API Client ID}}" \
     -H "X-CLIENT-SECRET: {{API Client Secret}}" \
     -d endDate=1707417000000 \
     -d offset=0 \
     -d startDate=1707217922000

200Debit Note_Fetch All Debit Notes_example

{
  "debitNotes": [
    {
      "id": 103,
      "debitNoteId": "DN-INDIAN-000000015",
      "billNo": "# 674854\ncreated on 30/01/2024",
      "date": 1707417000000,
      "createdAt": 1707469470938,
      "updatedAt": 1707469470962,
      "amount": 608.96,
      "currencyAmount": 608.96,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 469761,
        "invoiceId": "VI-INDIAN-000001961",
        "amount": 1254.64,
        "currencyAmount": 1254.64,
        "owner": {
          "id": 17253,
          "ownerType": "EMPLOYEE",
          "ownerId": "0001",
          "ownerName": "karanss kumar"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1707417000000,
        "dueDate": 1708281000000,
        "createdAt": 1707469364441
      },
      "vendor": {
        "id": 231492,
        "registeredId": "test",
        "name": "SKPL ANTREPRIZ SOLUTIONS PRIVATE LIMITED",
        "tradeName": "SKPL ANTREPRIZ SOLUTIONS PRIVATE LIMITED",
        "pan": "AAZCS7239P",
        "rcVendor": false
      },
      "officeData": {
        "id": 1346,
        "name": "Mumbaij",
        "address": "wlidjfsdf"
      }
    },
    {
      "id": 102,
      "debitNoteId": "DN-INDIAN-000000014",
      "billNo": "54cghj",
      "date": 1707330600000,
      "createdAt": 1707469399133,
      "updatedAt": 1707469399156,
      "amount": 10,
      "currencyAmount": 10,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 468802,
        "invoiceId": "VI-INDIAN-000001955",
        "amount": 21,
        "currencyAmount": 21,
        "owner": {
          "id": 434030,
          "ownerType": "EMPLOYEE",
          "ownerId": "e0099",
          "ownerName": "srinivas ss"
        },
        "status": "PENDING",
        "date": 1707330600000,
        "dueDate": 1707330600000,
        "createdAt": 1707382269131
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune",
        "address": "string"
      }
    },
    {
      "id": 101,
      "debitNoteId": "DN-INDIAN-000000013",
      "billNo": "gfdxxfcghbn",
      "date": 1707417000000,
      "createdAt": 1707468980330,
      "updatedAt": 1707468980357,
      "amount": 118,
      "currencyAmount": 118,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 469600,
        "invoiceId": "VI-INDIAN-000001960",
        "amount": 14160,
        "currencyAmount": 14160,
        "owner": {
          "id": 434030,
          "ownerType": "EMPLOYEE",
          "ownerId": "e0099",
          "ownerName": "srinivas ss"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1707417000000,
        "dueDate": 1707417000000,
        "createdAt": 1707464232504
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune",
        "address": "string"
      }
    },
    {
      "id": 100,
      "debitNoteId": "DN-INDIAN-000000012",
      "billNo": "14",
      "date": 1707417000000,
      "createdAt": 1707464911844,
      "updatedAt": 1707464911864,
      "amount": 12,
      "currencyAmount": 12,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 469434,
        "invoiceId": "VI-INDIAN-000001958",
        "amount": 133,
        "currencyAmount": 133,
        "owner": {
          "id": 287032,
          "ownerType": "CONTACT",
          "ownerId": "287032",
          "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1707417000000,
        "dueDate": 1707417000000,
        "createdAt": 1707459075806
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune",
        "address": "string"
      }
    },
    {
      "id": 99,
      "debitNoteId": "DN-INDIAN-000000011",
      "billNo": "14",
      "date": 1707417000000,
      "createdAt": 1707464889072,
      "updatedAt": 1707464889108,
      "amount": 16,
      "currencyAmount": 16,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 469434,
        "invoiceId": "VI-INDIAN-000001958",
        "amount": 133,
        "currencyAmount": 133,
        "owner": {
          "id": 287032,
          "ownerType": "CONTACT",
          "ownerId": "287032",
          "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1707417000000,
        "dueDate": 1707417000000,
        "createdAt": 1707459075806
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune",
        "address": "string"
      }
    },
    {
      "id": 98,
      "debitNoteId": "DN-INDIAN-000000010",
      "billNo": "14",
      "date": 1707417000000,
      "createdAt": 1707462112971,
      "updatedAt": 1707464911859,
      "amount": 60,
      "currencyAmount": 60,
      "currency": "INR",
      "stage": "start",
      "status": "COMPLETED",
      "service": "karan",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 469434,
        "invoiceId": "VI-INDIAN-000001958",
        "amount": 133,
        "currencyAmount": 133,
        "owner": {
          "id": 287032,
          "ownerType": "CONTACT",
          "ownerId": "287032",
          "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1707417000000,
        "dueDate": 1707417000000,
        "createdAt": 1707459075806
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune",
        "address": "string"
      }
    }
  ],
  "total": 6,
  "currentPage": 0,
  "totalPages": 1
}

Fetch All Debit Notes

This endpoint is a GET request to retrieve All Debit Notes based on the given time stamp.

Request Parameters

This API is use to get all Invoices existing in Dice.

Params	Required	Description
start_date	Mandatory	Date filter, from which date Debit notes needs to be fetched. Format - Unix timestamp
end_date	Mandatory	Date filter, till which date the Debit notes need to be fetched. Format - Unix timestamp
offset	Mandatory	Page Number

Query parameters

startDateintegerOptional

Start date (unix timestamp) for filtering credit notes.

endDateintegerOptional

Start date (unix timestamp) for filtering credit notes.

offsetintegerOptional

Offset starts from 0 (Page Number), values can be 0, 1, 2

Response

debitNoteslist of objects

totalinteger

currentPageinteger

totalPagesinteger

Request Parameters

Headers

Query parameters

Response