> ## 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.

# Get allocations

> Returns the full audit log of invoice allocations made against this credit note, showing credited invoices, amounts, timestamps, and notes.

### Headers

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

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

### Path Parameters

**id** `string` *required*

The unique ID (UUID) of the credit note whose allocation history to inspect.

### Response Body

**data\[].id** `string`

Unique identifier of the allocation event.

**data\[].creditNoteId** `string`

Source credit note UUID.

**data\[].invoiceId** `string`

Target invoice UUID credited.

**data\[].invoiceNumber** `string`

Target invoice display number (e.g. `INV-0002`).

**data\[].amount** `number`

Amount applied in this allocation event.

**data\[].notes** `string`

Allocation remarks or transaction reference.

**data\[].appliedAt** `string`

Timestamp when the credit was applied.

### Response Codes

| Code | Description |
| - | - |
| 200 | Allocation history retrieved successfully. |
| 401 | Unauthorized. Missing or invalid credentials. |
| 404 | Not Found. Credit note not found. |
| 500 | Internal server error. |

```bash cURL theme={null}
curl -X GET https://qa-payments.mygigsters.com.au/api/v1/credit-notes/1/allocations \
  -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/1/allocations", {
  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/1/allocations",
    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/1/allocations")
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/1/allocations");

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/1/allocations"))
            .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/1/allocations", 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/1/allocations");
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,
  "data": {
    "credit_note_number": "CN-0001",
    "total_amount": "50.00",
    "remaining_amount": "10.00",
    "applied_amount": "40.00",
    "allocations": [
      {
        "id": 2,
        "credit_note_id": 1,
        "invoice_id": "669dc683-4ad1-4971-a743-90d908788f01",
        "amount": "15.00",
        "notes": "Applying partial credit to invoice INV-4717",
        "deleted_at": null,
        "created_at": "2026-09-16T06:12:17.000Z",
        "updated_at": "2026-09-16T06:12:17.000Z"
      },
      {
        "id": 1,
        "credit_note_id": 1,
        "invoice_id": "669dc683-4ad1-4971-a743-90d908788f01",
        "amount": "25.00",
        "notes": "Applying partial credit to invoice INV-4717",
        "deleted_at": null,
        "created_at": "2026-09-16T06:09:54.000Z",
        "updated_at": "2026-09-16T06:09:54.000Z"
      }
    ]
  }
}
```


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