CreditNotesTable component

Overview

CreditNotesTable is a React component that displays all credit notes created by an entity. The component shows each credit note’s amount, status, issuance date, and counterpart to which they were sent.

Permissions

To access this component, the entity user must have read permissions for the receivable object. For more information, see List of permissions.

Preview

You can move and organize the columns of the table the way you prefer.

Usage

Use the CreditNotesTable component in your application as follows:

React.js

1 import { CreditNotesTable } from "@monite/sdk-react";
2 
3 ...
4 
5 // TODO: This component must be rendered within the MoniteProvider wrapper
6 const CreditNotesTablePage = () => {
7  return  <CreditNotesTable />
8 };

Props

filters

array of string

A list of search filters to display above the data table. Each filter is defined by the name of the underlying data field. UI labels of the filter inputs are populated automatically.

The default filters are: credit note number (partial match), status, and counterpart.

Example:

1 <CreditNotesTable filters={[
2   "document_id__contains",
3   "status",
4   "counterpart_id"
5 ]} />

onRowClick

function

This callback takes the identifier of the clicked row as a parameter and is triggered when a credit note table row is clicked.

query

object

The data query used to populate the table. The object’s fields correspond to the query parameters of the GET /receivables endpoint. The type field is required, others are optional.

Example: display only draft credit notes, newest first:

1 <CreditNotesTable query={{
2   type: "credit_note",
3   status: "draft",
4   sort: "created_at",
5   order: "desc"
6 }} />