List a reconciliation's refunds

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/reconciliations/3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f/sale_refunds?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.reconciliations.get_reconciliation_sale_refunds(
    "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.reconciliations.getReconciliationSaleRefunds('3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->reconciliations->getReconciliationSaleRefunds(
    '3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.reconciliations().getReconciliationSaleRefunds(
        "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Reconciliations.GetReconciliationSaleRefundsAsync(
    "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.reconciliations.getReconciliationSaleRefunds(
  '3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f',
  queryParams: {'limit': 20},
);
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.Reconciliations().GetReconciliationSaleRefunds(context.Background(), "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

GET

reconciliations

{reconciliation_id}

sale_refunds

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/reconciliations/3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f/sale_refunds?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

from exsited import build_client

client = build_client()

response = client.reconciliations.get_reconciliation_sale_refunds(
    "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f", {"limit": 20}
)
print(response.data)

import {buildClient} from 'exsited';

const client = await buildClient();

const response = await client.reconciliations.getReconciliationSaleRefunds('3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f', {
    limit: 20,
});
console.log(response.data);

use Exsited\Client\ClientRegistry;

$client = ClientRegistry::buildClient();

$response = $client->reconciliations->getReconciliationSaleRefunds(
    '3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f',
    ['limit' => 20],
);
print_r($response->data);

import com.exsited.Dto;
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import java.util.Map;

ExsitedClient client = ClientRegistry.buildClient();

ApiResponse<Dto> response = client.reconciliations().getReconciliationSaleRefunds(
        "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f",
        Map.of("limit", 20));
System.out.println(response.getMap());

using Exsited.Client;

await using var client = ExsitedClient.BuildClient();

var response = await client.Reconciliations.GetReconciliationSaleRefundsAsync(
    "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f",
    new Dictionary<string, object?> { ["limit"] = 20 });

Console.WriteLine(response.Json);

import 'package:exsited/exsited.dart';

final client = buildClient();

final response = await client.reconciliations.getReconciliationSaleRefunds(
  '3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f',
  queryParams: {'limit': 20},
);
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.Reconciliations().GetReconciliationSaleRefunds(context.Background(), "3c9d2e1f-5a6b-4c7d-8e9f-1a2b3c4d5e6f", map[string]any{"limit": 20}, nil)
if err != nil {
	log.Fatal(err)
}
fmt.Println(response.Map)

{
  "object": "<string>",
  "request_id": "<string>",
  "status": 123,
  "code": "<string>",
  "message": "<string>",
  "doc_url": "<string>",
  "errors": [
    {
      "field": "<string>",
      "code": "<string>",
      "message": "<string>",
      "doc_url": "<string>"
    }
  ]
}

Lists the refunds in one reconciliation, under data. An unknown reconciliation returns 404 with the code resource_not_found. To filter, add filter_<field>=<value>, or filter_<field>_<operator>=<value> with an operator such as gte or contains.

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

reconciliation_id

string

required

The reconciliation's uuid or its numeric id.

Query Parameters

limit

integer

The most records to return on one page.

Example:

20

Response

The reconciliation's refunds, under data.

Guides

API reference

List a reconciliation's refunds

Authorizations

Path Parameters

Query Parameters

Response