# Export credit notes

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


[Idempotency Supported](/docs/api/idempotency)

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

This API triggers export of credit note data. The exported zip file contains CSV files with credit note-related data.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/exports/credit_notes \
     -u {site_api_key}:\
     -d "credit_note[type][is]"="ADJUSTMENT" \
     -d "credit_note[total][lte]"="1200"
```

#### .NET

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

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = Export.CreditNotes()
		.CreditNoteType().Is(CreditNote.TypeEnum.Adjustment)
		.CreditNoteTotal().Lte(1200)
		.Request();

Export export = result.Export;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    "github.com/chargebee/chargebee-go/v3/filter"
    exportAction "github.com/chargebee/chargebee-go/v3/actions/export"
    "github.com/chargebee/chargebee-go/v3/models/export"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := exportAction.CreditNotes(&export.CreditNotesRequestParams{
        CreditNote : &export.CreditNotesCreditNoteParams{
            Type : &filter.EnumFilter{
                Is : "adjustment",
            },
            Total : &filter.NumberFilter{
                Lte : 1200,
            },
        },
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        Export := res.Export
    }
}
```

#### 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.ExportCreditNotesRequest{
    CreditNote : &chargebee.ExportCreditNotesCreditNote{
        Type : &chargebee.EnumFilter{
            Is : "adjustment",
        },
        Total : &chargebee.NumberFilter{
            Lte : 1200,
        },
    },
}
  res, err := client.Export.CreditNotes(req)
      if err != nil {
        fmt.Println(err)
    } else {
        Export := res.Export
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = Export.creditNotes().creditNoteType().is(CreditNote.Type.ADJUSTMENT).creditNoteTotal().lte(1200L).request();

        Export export = result.export();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.export.Export;
import com.chargebee.v4.models.export.params.ExportCreditNotesParams;
import com.chargebee.v4.models.export.responses.ExportCreditNotesResponse;

public class ExportCreditNotes {

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

        ExportCreditNotesParams.CreditNoteParams creditNote =
            ExportCreditNotesParams.CreditNoteParams.builder()
                .type()
                .is(ExportCreditNotesParams.CreditNoteParams.Type.ADJUSTMENT)
                .total()
                .lte(1200L)
                .build();

        ExportCreditNotesParams params = ExportCreditNotesParams.builder()
            .creditNote(creditNote)
            .build();

        ExportCreditNotesResponse response = client.exports().creditNotes(params);

        Export export = response.getExport();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

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

try {
    const result = await chargebee.export.creditNotes({
        credit_note: {
            type: {
                is: "adjustment"
            },
            total: {
                lte: 1200
            }
        }
    });

    console.log(result);
    const export_response = result.export;
} 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->export()->creditNotes([
    "credit_note" => [
        "type" => [
            "is" => "adjustment"
        ],
        "total" => [
            "lte" => 1200
        ]
    ]
]);
$export = $result->export;
```

#### Python

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

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.Export.credit_notes(
    cb_client.Export.CreditNotesParams(
        credit_note=cb_client.Export.CreditNotesCreditNoteParams(
            type=Filters.EnumFilter(IS=chargebee.CreditNote.Type.ADJUSTMENT),
            total=Filters.NumberFilter(LTE="1200")
        )
    )
)
export = response.export
```

#### Ruby

```ruby
require 'chargebee'

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

result = ChargeBee::Export.credit_notes({
  "credit_note[type][is]" => "adjustment",
  "credit_note[total][lte]" => 1200
})

export = result.export
```

## Sample Response

```json
{
  "export": {
    "created_at": 1527791400,
    "id": "__test__KyVnHhSBWTBby8o",
    "mime_type": "zip",
    "object": "export",
    "operation_type": "Credit Notes",
    "status": "in_process"
  }
}
```

## URL Format

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

## Input Parameters

- `credit_note` (optional, string)
  Parameters for credit\_note
  - `id` (optional, string)
    Credit-note id.
  - `customer_id` (optional, string)
    The identifier of the customer this Credit Note belongs to.
  - `subscription_id` (optional, string)
    To filter based on subscription\_id. NOTE: Not to be used if _consolidated invoicing_ feature is enabled.
  - `reference_invoice_id` (optional, string)
    The identifier of the invoice against which this Credit Note is issued
  - `type` (optional, enumerated string)
    The credit note type. [Learn more](/docs/api/credit_notes/credit-note-object) about credit note types.
  - `reason_code` (optional, enumerated string)
    The reason for issuing this Credit Note. The following reason codes are supported now\[Deprecated; use the [create\_reason\_code](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\]
  - `create_reason_code` (optional, string)
    Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings > Configure Chargebee > Reason Codes > Credit Notes > Create Credit Note**. Must be passed if set as mandatory in the app. The codes are case-sensitive
  - `status` (optional, enumerated string)
    The credit note status.
  - `total` (optional, number)
    Credit Note amount in cents.
  - `price_type` (optional, enumerated string)
    The price type of the Credit Note.
  - `amount_allocated` (optional, number)
    The amount allocated to the invoices.
  - `amount_refunded` (optional, number)
    The refunds issued from this Credit Note.
  - `amount_available` (optional, number)
    The yet to be used credits of this Credit Note.
  - `channel` (optional, enumerated string)
    The subscription channel this object originated from and is maintained in.
  - `date` (optional, timestamp(UTC) in seconds)
    The date the Credit Note is issued.
    - `after` (optional, timestamp(UTC) in seconds)
    - `before` (optional, timestamp(UTC) in seconds)
    - `on` (optional, timestamp(UTC) in seconds)
  - `voided_at` (optional, timestamp(UTC) in seconds)
    Timestamp indicating the date and time this Credit Note gets voided.
    - `after` (optional, timestamp(UTC) in seconds)
    - `before` (optional, timestamp(UTC) in seconds)
    - `on` (optional, timestamp(UTC) in seconds)
  - `updated_at` (optional, timestamp(UTC) in seconds)
    To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.
    - `after` (optional, timestamp(UTC) in seconds)
    - `before` (optional, timestamp(UTC) in seconds)
    - `on` (optional, timestamp(UTC) in seconds)

## Returns

- `export` (Export object)
  Resource object representing export