Skip to main content

​
Import

import { useSettlements } from '@keystoneos/react';

​
Usage

function SettlementList() {
  const { settlements, total, isLoading, error } = useSettlements({
    state: 'AWAITING_DEPOSITS',
    limit: 20,
    offset: 0,
  });

  if (isLoading) return <Spinner />;

  return (
    <div>
      <p>{total} settlements</p>
      {settlements.map(s => (
        <div key={s.id}>
          {s.external_reference} - {s.state}
        </div>
      ))}
    </div>
  );
}

​
Parameters

ParameterTypeRequiredDescription
optionsUseSettlementsOptionsNoFilter and pagination options.

​
UseSettlementsOptions

PropertyTypeDefaultDescription
statestring-Filter by settlement state (e.g., "FINALIZED").
limitnumber50Maximum items per page.
offsetnumber0Number of items to skip.

​
Return Type

interface UseSettlementsResult {
  settlements: Settlement[];
  total: number;
  isLoading: boolean;
  error: string | null;
  refetch: () => Promise<void>;
}
PropertyTypeDescription
settlementsSettlement[]Array of settlements for the current page.
totalnumberTotal number of matching settlements (for pagination).
isLoadingbooleantrue during fetch.
errorstring | nullError message if the fetch failed.
refetch() => Promise<void>Manually trigger a re-fetch.

​
Behavior

  • Fetches on mount and whenever options change.
  • Re-fetches automatically when state, limit, or offset changes.
  • Returns settlements scoped to the platform and environment in the session token.

​
Pagination Example

function PaginatedList() {
  const [page, setPage] = useState(0);
  const pageSize = 20;

  const { settlements, total } = useSettlements({
    limit: pageSize,
    offset: page * pageSize,
  });

  const totalPages = Math.ceil(total / pageSize);

  return (
    <div>
      {settlements.map(s => <SettlementRow key={s.id} settlement={s} />)}
      <div>
        <button onClick={() => setPage(p => p - 1)} disabled={page === 0}>Previous</button>
        <span>Page {page + 1} of {totalPages}</span>
        <button onClick={() => setPage(p => p + 1)} disabled={page >= totalPages - 1}>Next</button>
      </div>
    </div>
  );
}