> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mygigsters.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List credit notes

> Returns a paginated list of credit notes with support for status filtering, text search, column sorting, and overall summary analytics.

### Headers

**X-API-Version** `string` *required* (default: 1.2)

The API version to use. Supported versions are `1.1` and `1.2`.

### Query Parameters

**status** `string`

Filter by status: `DRAFT`, `ISSUED`, `PARTIALLY_APPLIED`, `FULLY_APPLIED`, `VOIDED`, or `all`.

**search** `string`

Text search filter matching credit note number, customer name, or invoice number.

**page** `number`

Page number for pagination. Default is `1`.

**limit** `number`

Number of records per page. Default is `10`.

**sort\_by** `string`

Sort attribute: `createdAt`, `totalAmount`, `remainingAmount`. Default is `createdAt`.

**sort\_order** `string`

Sort direction: `ASC` or `DESC`. Default is `DESC`.

### Response Body

**success** `boolean`

Indicates whether the request was successful.

**totalItems** `number`

Total count of matching credit notes across pages.

**totalPages** `number`

Total number of pages available.

**currentPage** `number`

Current active page index.

**data** `array`

Array of credit note objects matching query parameters.

**summary** `object`

Summary metrics including `totalDraftAmount`, `totalIssued`, `totalRemaining`, and `totalApplied`.

### Response Codes

| Code | Description |
| - | - |
| 200 | Credit notes list retrieved successfully. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 500 | Internal server error. |

```bash cURL theme={null}
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/credit-notes \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json"
```

```javascript Node.js theme={null}
const response = await fetch("https://qa-payments.mygigsters.com.au/api/v1/credit-notes", {
  method: "GET",
  headers: {
    Authorization: "Basic " + Buffer.from("YOUR_UUID:YOUR_SECRET").toString("base64"),
    "X-API-Version": "1.2",
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);
```

```python Python theme={null}
import requests

response = requests.get(
    "https://qa-payments.mygigsters.com.au/api/v1/credit-notes",
    auth=("YOUR_UUID", "YOUR_SECRET"),
    headers={
        "X-API-Version": "1.2",
        "Content-Type": "application/json",
    },
)

print(response.json())
```

```ruby Ruby theme={null}
require "net/http"
require "json"
require "uri"

uri = URI("https://qa-payments.mygigsters.com.au/api/v1/credit-notes")
request = Net::HTTP::Get.new(uri)
request.basic_auth("YOUR_UUID", "YOUR_SECRET")
request["X-API-Version"] = "1.2"
request["Content-Type"] = "application/json"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts JSON.parse(response.body)
```

```php PHP theme={null}
<?php

$ch = curl_init("https://qa-payments.mygigsters.com.au/api/v1/credit-notes");

curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_USERPWD => "YOUR_UUID:YOUR_SECRET",
    CURLOPT_HTTPHEADER => [
        "X-API-Version: 1.2",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

print_r(json_decode($response, true));
```

```java Java theme={null}
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

public class Example {
    public static void main(String[] args) throws Exception {
        String credentials = Base64.getEncoder()
            .encodeToString("YOUR_UUID:YOUR_SECRET".getBytes());

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://qa-payments.mygigsters.com.au/api/v1/credit-notes"))
            .header("Authorization", "Basic " + credentials)
            .header("X-API-Version", "1.2")
            .header("Content-Type", "application/json")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}
```

```go Go theme={null}
package main

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

func main() {
	req, err := http.NewRequest("GET", "https://qa-payments.mygigsters.com.au/api/v1/credit-notes", nil)
	if err != nil {
		panic(err)
	}
	req.SetBasicAuth("YOUR_UUID", "YOUR_SECRET")
	req.Header.Set("X-API-Version", "1.2")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}
```

```csharp .NET theme={null}
using System.Net.Http.Headers;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://qa-payments.mygigsters.com.au/api/v1/credit-notes");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Basic", Convert.ToBase64String(Encoding.UTF8.GetBytes("YOUR_UUID:YOUR_SECRET")));
request.Headers.Add("X-API-Version", "1.2");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
```

```json Response theme={null}
{
  "success": true,
  "total_items": 1,
  "total_pages": 1,
  "current_page": 1,
  "page_size": 10,
  "data": [
    {
      "id": 1,
      "credit_note_number": "CN-0001",
      "client_id": "4407c3ba-10c9-4822-9f51-c2c96692f8d7",
      "customer_id": "4407c3ba-10c9-4822-9f51-c2c96692f8d7",
      "invoice_id": "669dc683-4ad1-4971-a743-90d908788f01",
      "invoice_number": "INV-4717",
      "payment_id": null,
      "total_amount": "50.00",
      "remaining_amount": "50.00",
      "applied_amount": "0.00",
      "currency": "AUD",
      "status": "ISSUED",
      "reason": "Customer discount / Service dispute",
      "description": "50 AUD credit issued for overbilled service hours",
      "date": "2026-09-16T05:51:09.000Z",
      "deleted_at": null,
      "created_at": "2026-09-16T05:51:09.000Z",
      "updated_at": "2026-09-16T05:51:09.000Z",
      "allocations": []
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.