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

# Retrieve refund statement credit-note breakdown

GET https://api.letsdeel.com/rest/refund-statements/{refund_statement_id}/breakdown

Use this endpoint to retrieve a detailed breakdown of credit notes associated with a specific refund statement. It provides comprehensive details for financial tracking and reconciliation.

 **Token scopes**: `accounting:read`

Reference: https://developer.deel.com/api/reference/endpoints/refund-statements/retrieve-refund-statement-credit-note-breakdown-v-2026-05-11

## Authentication

- `Authorization` header (bearer token, required) — ## Authentication The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail. ```curl curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)
- `Authorization` header (bearer token, required) — Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

## Servers

- `https://api.letsdeel.com/rest` (Production, default)
- `https://api-staging.letsdeel.com/rest` (Demo)

## Request

### Path parameters

- `refund_statement_id` (string, required) — Public id (`invoice_id`) of the refund statement root invoice.

## Response

### 200

Breakdown succeeded. `data` contains zero or more rows (empty array when there are no child credit notes).

- `data` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems, required) — Credit note / credit statement lines linked to this refund statement.
- `hasMore` (boolean, required) — Reserved for pagination; currently always false (full breakdown returned in `data`).
- `nextCursor` (string, required, nullable) — Reserved for cursor pagination; currently always null for this endpoint.

## Errors

### 400 Bad Request Error

Bad request: missing organization context, or request validation failed (e.g. invalid path id format, invalid query types).

- `errors` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems, required)

### 401 Unauthorized Error

Unauthorized: caller is not authenticated (e.g. missing or invalid session or bearer token).

- `errors` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems, required)

### 403 Forbidden Error

Forbidden (role or feature flag).

- `errors` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems, required)

### 404 Not Found Error

Statement not found or not accessible.

- `errors` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems, required)

### 500 Internal Server Error

Unexpected server failure.

- `errors` (list of RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems, optional) — Structured errors when the runtime could serialize them; may be absent or empty.

## Types

### RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems

- `id` (string, required) — Public id of the credit note (or credit statement line) invoice.
- `label` (string, required) — Display label (sequencing label or description fallback).
- `amount` (string, required) — Credit amount; typically negative for credits.
- `currency` (string, required) — ISO 4217 currency code.
- `contract_id` (string, optional, nullable) — Contract `oid` when the credit note is tied to a contract; otherwise null.
- `original_invoice_id` (string, optional, nullable) — Public id of the invoice being credited when applicable; `null` when not linked.

### RefundStatementsRefundStatementIdBreakdownGetResponsesContentApplicationJsonSchemaErrorsItems

- `code` (string, optional) — Machine-readable code when present.
- `message` (string, optional) — Human-readable message when present.

## Examples

### No child credit notes

**Response**

```json
{
  "data": [],
  "hasMore": false,
  "nextCursor": null
}
```

**SDK Code**

```python No child credit notes
import requests

url = "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript No child credit notes
const url = 'https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go No child credit notes
package main

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

func main() {

	url := "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby No child credit notes
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java No child credit notes
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php No child credit notes
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp No child credit notes
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift No child credit notes
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")! 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()
```

### Credit notes with and without contract

**Response**

```json
{
  "data": [
    {
      "id": "inv_cn_01jq_example_zx81",
      "label": "CN-2026-00042",
      "amount": "-150.00",
      "currency": "USD",
      "contract_id": "cntr_01jq_example_ab12",
      "original_invoice_id": "inv_01jq_example_orig"
    },
    {
      "id": "inv_cn_01jq_example_noc",
      "label": "Standalone credit",
      "amount": "-25.50",
      "currency": "USD",
      "original_invoice_id": null
    }
  ],
  "hasMore": false,
  "nextCursor": null
}
```

**SDK Code**

```python Credit notes with and without contract
import requests

url = "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript Credit notes with and without contract
const url = 'https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

```go Credit notes with and without contract
package main

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

func main() {

	url := "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

```ruby Credit notes with and without contract
require 'uri'
require 'net/http'

url = URI("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java Credit notes with and without contract
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Credit notes with and without contract
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Credit notes with and without contract
using RestSharp;

var client = new RestClient("https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Credit notes with and without contract
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.letsdeel.com/rest/refund-statements/inv_refund_stmt_01jq_example_a9fd/breakdown")! 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()
```