dolfindevelopers

Supplier credit note detail page

PagePayablesSDK + UI

One supplier credit note: back link, header with Issue, Delete and Apply to bill, figures, details, history and the bills it was applied to. Accepts your own header actions and an aside.

Page: A complete screen for one route, such as a bill or the invoices list. Mount it on a route in your app; connected SDK pages provide data and actions; standalone UI pages receive them as props. Pages vs components

Choose your integration

Works with Dolfin’s SDK context, with appearance and behaviour you can customise. Requires DolfinProvider.

Loading preview…

Installation

Needs the Dolfin registry token. The CLI copies the source into your app.

Terminal
bunx --bun shadcn@4.23.0 add @dolfin/ap-supplier-credit-note-detail-page

Also installs: ap-supplier-credit-note-detail, base-page, ui-ap-supplier-credit-note-detail-page.

Usage

route.tsx
import { SupplierCreditNoteDetailPage } from "@/components/dolfin/ap/supplier-credit-note-detail-page";

// A whole screen: mount it on a route, inside your <DolfinProvider>.
export default function Route({ params }: { params: { creditNoteId: string } }) {
  return <SupplierCreditNoteDetailPage creditNoteId={params.creditNoteId} />;
}

Renders inside DolfinProvider (set it up once). It renders the data you pass as props.

API reference

PropTypeDescription
creditNoteId requiredstring
headerActionsstring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…Beside Issue, Delete and Apply to bill.
asidestring | number | bigint | boolean | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<ReactNode> | React.Re…A column beside the note (e.g. where it stands in your books).
hideBackLinkbooleanHide the "Back to supplier credit notes" link.
onDeleted() => voidAfter a draft is deleted; goes back to the list by default.
onApplied(result: ApplySupplierCreditResult) => void
classNamestring

Customisation

Without editing the source, you can change:

Class names
className
Messages
ap.supplierCreditNotes.detail

Or edit the installed file directly: it is your code. See theming for colours and fonts.

Hooks

The SDK hooks this page uses. Use them directly from @dolfinai/react to build your own version.

useMessages

Files

Written to your app by the install command:

  • components/dolfin/ap/supplier-credit-note-detail-page.tsx 62 lines