List a refund note's files

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/refunds/REF-0001/notes/note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d/files" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.refunds.getRefundNoteFiles('REF-0001', 'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->refunds->getRefundNoteFiles(
    'REF-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.accounts.accounts_dto.AccountsDto.NoteFileList;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<NoteFileList> response = client.refunds().getRefundNoteFiles(
        "REF-0001",
        "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Refunds.GetRefundNoteFilesAsync(
    "REF-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.refunds.getRefundNoteFiles(
  'REF-0001',
  'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Refunds().GetRefundNoteFiles(context.Background(), "REF-0001", "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "uuid": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123,
      "href": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

GET

refunds

{refund_id}

notes

{note_id}

files

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/refunds/REF-0001/notes/note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d/files" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.refunds.getRefundNoteFiles('REF-0001', 'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d');
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->refunds->getRefundNoteFiles(
    'REF-0001',
    'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
);
print_r($response->data);

import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.accounts.accounts_dto.AccountsDto.NoteFileList;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<NoteFileList> response = client.refunds().getRefundNoteFiles(
        "REF-0001",
        "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d");
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Refunds.GetRefundNoteFilesAsync(
    "REF-0001",
    "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d");

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.refunds.getRefundNoteFiles(
  'REF-0001',
  'note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d',
);
print(response.map);

import (
	"context"
	"fmt"
	"log"

	exsited "github.com/exsited/exsited-sdk-go/v4"
)

client, err := exsited.BuildClient(nil)
if err != nil {
	log.Fatal(err)
}
defer client.Close()

response, err := client.Refunds().GetRefundNoteFiles(context.Background(), "REF-0001", "note_3f2b8c1d9e4a4f6b8c2d1e0f9a8b7c6d", nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "url": "<string>",
  "data": [
    {
      "uuid": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "size": 123,
      "href": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "links": {
      "next": "<string>",
      "prev": "<string>"
    }
  }
}

Lists the note’s attachments under data, each with its uuid, filename, content_type, size and href.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization

string

header

required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Path Parameters

refund_id

string

required

The refund's code, which the refunds listing returns as id.

note_id

string

required

The note's id, which starts with note_.

Response

200 - application/json

The note's files, under data.

object

string

url

string

data

object[]

Show child attributes

pagination

object

Show child attributes

Guides

API reference

Authorizations

Path Parameters

Response