> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://open-api-docs.dice.tech/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://open-api-docs.dice.tech/_mcp/server.

# Fetch All Credit Notes

GET https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes

**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                                                                        |

Reference: https://open-api-docs.dice.tech/dice-standardized-ap-is-v-2-copy/credit-note/fetch-all-credit-notes

## Servers

- `https://heimdall.eka.io` (https://heimdall.eka.io, default)
- `https://heimdall.eka.ioapis` (https://heimdall.eka.ioapis)

## Request

### Query parameters

- `startDate` (integer, optional) — Start date (unix timestamp) for filtering credit notes.
- `endDate` (integer, optional) — Start date (unix timestamp) for filtering credit notes.
- `offset` (integer, optional) — Offset starts from 0 (Page Number), values can be 0, 1, 2

### Headers

- `DICE-APP-ID` (string, optional)
- `X-CLIENT-ID` (string, optional)
- `X-CLIENT-SECRET` (string, optional)

## Response

### 200

OK

- `creditNotes` (list of object, required)
  - `id` (integer, required)
  - `creditNoteId` (string, required)
  - `billNo` (string, required)
  - `date` (integer, required)
  - `createdAt` (integer, required)
  - `updatedAt` (integer, required)
  - `amount` (double, required)
  - `currencyAmount` (double, required)
  - `currency` (string, required)
  - `stage` (string, required)
  - `status` (string, required)
  - `category` (string, required)
  - `categoryId` (integer, required)
  - `owner` (object, required)
    - `id` (integer, required)
    - `ownerType` (string, required)
    - `ownerId` (string, required)
    - `ownerName` (string, required)
  - `invoice` (object, required)
    - `id` (integer, required)
    - `invoiceId` (string, required)
    - `amount` (double, required)
    - `currencyAmount` (double, required)
    - `owner` (object, required)
      - `id` (integer, required)
      - `ownerType` (string, required)
      - `ownerId` (string, required)
      - `ownerName` (string, required)
    - `status` (string, required)
    - `date` (integer, required)
    - `createdAt` (integer, required)
  - `vendor` (object, required)
    - `id` (integer, required)
    - `registeredId` (string, required)
    - `name` (string, required)
    - `tradeName` (string, required)
    - `pan` (string, required)
    - `rcVendor` (boolean, required)
  - `officeData` (object, required)
    - `id` (integer, required)
    - `name` (string, required)
- `total` (integer, required)
- `currentPage` (integer, required)
- `totalPages` (integer, required)

## Examples

**Response**

```json
{
  "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
}
```

**SDK Code**

```python Credit Note_Fetch All Credit Notes_example
import requests

url = "https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes"

querystring = {"endDate":"1709145000000","offset":"0","startDate":"1708972200000"}

headers = {
    "DICE-APP-ID": "{{Company Code}}",
    "X-CLIENT-ID": "{{API Client ID}}",
    "X-CLIENT-SECRET": "{{API Client Secret}}"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript Credit Note_Fetch All Credit Notes_example
const url = 'https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000';
const options = {
  method: 'GET',
  headers: {
    'DICE-APP-ID': '{{Company Code}}',
    'X-CLIENT-ID': '{{API Client ID}}',
    'X-CLIENT-SECRET': '{{API Client Secret}}'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Credit Note_Fetch All Credit Notes_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("DICE-APP-ID", "{{Company Code}}")
	req.Header.Add("X-CLIENT-ID", "{{API Client ID}}")
	req.Header.Add("X-CLIENT-SECRET", "{{API Client Secret}}")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Credit Note_Fetch All Credit Notes_example
require 'uri'
require 'net/http'

url = URI("https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["DICE-APP-ID"] = '{{Company Code}}'
request["X-CLIENT-ID"] = '{{API Client ID}}'
request["X-CLIENT-SECRET"] = '{{API Client Secret}}'

response = http.request(request)
puts response.read_body
```

```java Credit Note_Fetch All Credit Notes_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000")
  .header("DICE-APP-ID", "{{Company Code}}")
  .header("X-CLIENT-ID", "{{API Client ID}}")
  .header("X-CLIENT-SECRET", "{{API Client Secret}}")
  .asString();
```

```php Credit Note_Fetch All Credit Notes_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000', [
  'headers' => [
    'DICE-APP-ID' => '{{Company Code}}',
    'X-CLIENT-ID' => '{{API Client ID}}',
    'X-CLIENT-SECRET' => '{{API Client Secret}}',
  ],
]);

echo $response->getBody();
```

```csharp Credit Note_Fetch All Credit Notes_example
using RestSharp;

var client = new RestClient("https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000");
var request = new RestRequest(Method.GET);
request.AddHeader("DICE-APP-ID", "{{Company Code}}");
request.AddHeader("X-CLIENT-ID", "{{API Client ID}}");
request.AddHeader("X-CLIENT-SECRET", "{{API Client Secret}}");
IRestResponse response = client.Execute(request);
```

```swift Credit Note_Fetch All Credit Notes_example
import Foundation

let headers = [
  "DICE-APP-ID": "{{Company Code}}",
  "X-CLIENT-ID": "{{API Client ID}}",
  "X-CLIENT-SECRET": "{{API Client Secret}}"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://heimdall.eka.io/apis/external/vendor/creditNote/getAllCreditNotes?endDate=1709145000000&offset=0&startDate=1708972200000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```