useHandleDebitNote

useHandleDebitNote is a hook that allows you to handle (accept) a single debit note. It returns an object with the following properties:

Name	Description
acceptDebitNote	A function that accepts the debit note.
isLoading	Boolean indicating whether the debit note is being accepted.
error	The error explaining why the last attempt to accept the debit note failed.
isAccepted	Boolean indicating whether the debit note has been accepted.

Parameters

This hook accepts two parameters:

Name	Description
debitNote (required)	The id of the debit note to handle (you can get it from the useDebitNotes hook).
options (optional)	see below

Options

Name	Description
onAccepted (optional)	A function that will be called when the debit note is accepted. This is a good place to display a success message to the user.
onRejected (optional)	A function that will be called when the debit note is rejected. This is a good place to display an error message to the user.
allocationTimeoutMs (optional)	The timeout for the allocation in milliseconds. Defaults to 60 seconds.

Example

function MyComponent({ id, status }) {
  const { acceptDebitNote, isAccepted, isLoading } = useHandleDebitNote(id, {
    onAccepted: () => {
      showToast(`Debit note accepted! 💸`, { type: 'success' })
    },
    onRejected: () => {
      showToast(`There was an error accepting the debit note 😥`, {
        type: 'error',
      })
    },
  })
  return (
    <div>
      <p>{id}</p>
      <p>{status}</p>
      <button
        onClick={acceptDebitNote}
        disabled={status !== DebitNoteStatus.Received || isAccepted}
      >
        {isLoading ? 'Accepting...' : isAccepted ? 'Accepted!' : 'Accept'}
      </button>
    </div>
  )
}