# List credit notes

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Eventually Consistent](/docs/api/read-consistency)

Lists all the Credit Notes.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/credit_notes \
     -G  \
     -u {site_api_key}:\
     --data-urlencode limit=3 \
     --data-urlencode "type[is]"="REFUNDABLE" \
     --data-urlencode "sort_by[asc]"="date"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;
using ChargeBee.Models.Enums;
using ChargeBee.Filters.Enums;

ApiConfig.Configure("{site}","{site_api_key}");
ListResult result = CreditNote.List()
		.Limit(3)
		.Type().Is(CreditNote.TypeEnum.Refundable)
		.SortByDate(SortOrderEnum.Asc)
		.Request();

foreach (var listItem in result.List){
  CreditNote creditNote = listItem.CreditNote;
}
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    creditnoteAction "github.com/chargebee/chargebee-go/v3/actions/creditnote"
    "github.com/chargebee/chargebee-go/v3/models/creditnote"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := creditnoteAction.List(&creditnote.ListRequestParams{
        Limit : chargebee.Int32(3),
        Type : &filter.EnumFilter{
            Is : "refundable",
        },
        SortBy : &filter.SortFilter{
            Asc : "date",
        },
    }).ListRequest()
    if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            CreditNote := res.List[idx].CreditNote
        }
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.CreditNoteListRequest{
    Limit : chargebee.Int32(3),
    Type : &chargebee.EnumFilter{
        Is : "refundable",
    },
    SortBy : &chargebee.SortFilter{
        Asc : "date",
    },
}
  res, err := client.CreditNote.List(req)
      if err != nil {
        fmt.Println(err)
    } else {
        for idx := 0; idx < len(res.List); idx++ {
            CreditNote := res.List[idx].CreditNote
        }
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.filters.enums.SortOrder;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;
import java.util.List;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        ListResult result = CreditNote.list()
            .limit(3)
            .type().is(CreditNote.Type.REFUNDABLE)
            .sortByDate(SortOrder.ASC)
            .request();

        for (ListResult.Entry entry : result) {
            CreditNote creditNote = entry.creditNote();
        }
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.creditNote.CreditNote;
import com.chargebee.v4.models.creditNote.params.CreditNoteListParams;
import com.chargebee.v4.models.creditNote.responses.CreditNoteListResponse;
import java.util.List;

public class CreditNoteList {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        CreditNoteListParams params = CreditNoteListParams.builder()
            .limit(3)
            .type()
            .is(CreditNoteListParams.Type.REFUNDABLE)
            .sortBy()
            .date()
            .asc()
            .build();

        CreditNoteListResponse response = client.creditNotes().list(params);
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.creditNote.list({
        limit: 3,
        type: {
            is: "refundable"
        },
        "sort_by[asc]": "date"
    });
    result.list.forEach((entry) => {
        console.log(entry);
        const creditNote = entry.credit_note;
    });
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->creditNote()->all([
    "limit" => 3,
    "type" => [
        "is" => "refundable"
    ],
    "sort_by" => [
        "asc" => "date"
    ]
]);
foreach($result->list as $entry) {
    $creditNote = $entry->credit_note;
}
```

#### Python

```python
import chargebee
from chargebee import Chargebee, Filters

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
entries = cb_client.CreditNote.list(
    cb_client.CreditNote.ListParams(
        limit=3,
        type=Filters.EnumFilter(IS=chargebee.CreditNote.Type.REFUNDABLE),
        sort_by=Filters.SortFilter(ASC="date")
    )
)
for entry in entries.list:
    credit_note = entry.credit_note
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

list = ChargeBee::CreditNote.list({
  :limit => 3,
  "type[is]" => "refundable",
  "sort_by[asc]" => "date"
})

list.each do |entry|
  credit_note = entry.credit_note
end
```

## Sample Response

```json
{
  "list": [
    {
      "credit_note": {
        "allocations": {},
        "amount_allocated": 0,
        "amount_available": 500,
        "amount_refunded": 0,
        "base_currency_code": "USD",
        "create_reason_code": "Product Unsatisfactory",
        "currency_code": "USD",
        "customer_id": "__test__KyVnHhSBWSy4m5e",
        "date": 1517501405,
        "deleted": false,
        "exchange_rate": 1,
        "fractional_correction": 0,
        "id": "__demo_cn__1",
        "line_item_discounts": {},
        "line_item_taxes": {},
        "line_items": [
          {
            "amount": 500,
            "customer_id": "__test__KyVnHhSBWSy4m5e",
            "date_from": 1517501405,
            "date_to": 1517501405,
            "description": "Support Charge",
            "discount_amount": 0,
            "entity_type": "adhoc",
            "id": "li___test__KyVnHhSBWSyHE5r",
            "is_taxed": false,
            "item_level_discount_amount": 0,
            "object": "line_item",
            "pricing_model": "flat_fee",
            "quantity": 1,
            "tax_amount": 0,
            "tax_exempt_reason": "tax_not_configured",
            "unit_amount": 500
          },
          {..}
        ],
        "linked_refunds": {},
        "object": "credit_note",
        "price_type": "tax_exclusive",
        "reason_code": "product_unsatisfactory",
        "reference_invoice_id": "__demo_inv__1",
        "resource_version": 1517501405000,
        "round_off_amount": 0,
        "status": "refund_due",
        "sub_total": 500,
        "taxes": {},
        "total": 500,
        "type": "refundable",
        "updated_at": 1517501405
      }
    },
    {..}
  ]
}
```

## URL Format

**GET** https://[site].chargebee.com/api/v2/credit_notes

## Input Parameters

- `limit` (optional, integer, default=10, min=1, max=100)
  The number of resources to be returned.

- `offset` (optional, string, max chars=1000)
  Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

- `include_deleted` (optional, boolean, default=false)
  If set to true, includes the deleted resources in the response. For the deleted resources in the response, the '**deleted** ' attribute will be '**true** '.

## Returns

- `next_offset` (optional, string, max chars=1000)
  This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter `offset`.

- `credit_note` (Credit note object)
  Resource object representing credit\_note