Fetch All Credit Notes | DICE

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

{
  "creditNotes": [
    {
      "id": 230,
      "creditNoteId": "CN-INDIAN-000000162",
      "billNo": "CN-IN-TEST-20240002",
      "date": 1709145000000,
      "createdAt": 1709191867838,
      "updatedAt": 1709713178109,
      "amount": 2412.9,
      "currencyAmount": 2412.9,
      "currency": "INR",
      "stage": "start",
      "status": "APPROVAL",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 490975,
        "invoiceId": "VI-INDIAN-000002070",
        "amount": 43432.2,
        "currencyAmount": 43432.2,
        "owner": {
          "id": 287032,
          "ownerType": "CONTACT",
          "ownerId": "287032",
          "ownerName": "BAKKIREDDY SRINIVASULU REDDY"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1709145000000,
        "createdAt": 1709188438582
      },
      "vendor": {
        "id": 287032,
        "registeredId": "CONTACT-INDIAN-0000063",
        "name": "BAKKIREDDY SRINIVASULU REDDY",
        "tradeName": "TDTRFG",
        "pan": " AFQPA7358J",
        "rcVendor": false
      },
      "officeData": {
        "id": 1347,
        "name": "Pune"
      }
    },
    {
      "id": 226,
      "creditNoteId": "CN-INDIAN-000000160",
      "billNo": "0987890",
      "date": 1708972200000,
      "createdAt": 1709028614612,
      "updatedAt": 1709028614675,
      "amount": -38652,
      "currencyAmount": -38652,
      "currency": "INR",
      "stage": "start",
      "status": "APPROVAL",
      "category": "karan",
      "categoryId": 129,
      "owner": {
        "id": 118,
        "ownerType": "ADMIN",
        "ownerId": "118",
        "ownerName": "Admin"
      },
      "invoice": {
        "id": 488089,
        "invoiceId": "VI-INDIAN-000002058",
        "amount": 40560.4,
        "currencyAmount": 40560.4,
        "owner": {
          "id": 239645,
          "ownerType": "CONTACT",
          "ownerId": "239645",
          "ownerName": "Yash Enterprise"
        },
        "status": "CREDIT_NOTE_HOLD",
        "date": 1708972200000,
        "createdAt": 1709016071022
      },
      "vendor": {
        "id": 239645,
        "registeredId": "123454321",
        "name": "Yash Enterprise",
        "tradeName": "undefined",
        "pan": "EVSPR5588B",
        "rcVendor": false
      },
      "officeData": {
        "id": 74906,
        "name": "Eka Office",
        "address": "Paradise Colony, Indore, MP"
      },
      "service": "karan"
    }
  ],
  "total": 2,
  "currentPage": 0,
  "totalPages": 1
}

Fetch All Credit Notes

This endpoint is a GET request to retrieve All Credit 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 credit notes needs to be fetched. Format - long
end_date	Mandatory	Date filter, till which date the credit notes need to be fetched. Format - long
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

creditNoteslist of objects

totalinteger

currentPageinteger

totalPagesinteger

Request Parameters

Headers

Query parameters

Response