---
title: "Agreement Summary and Record Toolbar"
canonical: "https://bizcore.refined.site/space/BCKB/2058780710/Agreement%20Summary%20and%20Record%20Toolbar"
format: markdown
---
> Macro (toc)

# **Overview**

When an Agreement Record is created [Ad-Hoc by the user](https://bizcore.refined.site/space/BCKB/1806729224), or when a customer creates their own through the [Self-Service Page](https://bizcore.refined.site/space/BCKB/1779728385) or [Payment Gateway](https://bizcore.refined.site/space/BCKB/1830322183), users have a number of features available to assist with managing the agreement. This document provides an overview of the Agreement Summary and Record Toolbar. For agreement specific [How-to Guides](https://bizcore.refined.site/space/BCKB/1996292097), [Payment Statuses](https://bizcore.refined.site/space/BCKB/1953202235) or [Types of Authorisations](https://bizcore.refined.site/space/BCKB/2009366547) consult the relevant documentation pages.

---

# **Agreement Summary**

Every Agreement is accompanied by a summary that is visible within the Record. After accessing a Agreement Workspace Record, the summary will provide overview of key details:

![image](media://ad9919dd-4a79-4279-8d29-1aa3a0c2b8a5)

Starting from the top left and moving down, then across to the right, the explanations of the summary information are as follows:

| **Heading** | **Description** |
| --- | --- |
| Reference Number | Below the Agreement Summary heading is the Agreement’s unique [reference number](https://bizcore.refined.site/space/BCKB/1783890004/Records+%26+Statuses#Overview). |
| Type | This field will always be “Customer”, indicating you are debiting the customer. |
| Status | The [current status](https://bizcore.refined.site/space/BCKB/1783890004/Records+%26+Statuses#Agreement-Statuses) of the Agreement. This may change automatically if a [Direct Debit Cancellation (aka Payment Stop)](https://bizcore.refined.site/space/BCKB/1817444418/Direct+Debit+Claims+and+Cancellations#Cancellations-(AKA-Payment-Stop)) is requested by the customer, or can be manually adjusted by the user by clicking on the **Update Status ⇆** icon. |
| External Ref | Although Biz Core creates its own unique reference numbers for each record, users can also add an ID into the External Reference field. This may be done in the wizard while [creating an agreement Ad Hoc](https://bizcore.refined.site/space/BCKB/1806729224/Ad-hoc+Payment+Agreements), or added/changed from the Agreement Summary by clicking the **Pencil **✏️ icon. |
| Creation Date | The date the Agreement was created. |
| Paid | A count of successful payments and the dollar amount of the successful payments in brackets. |
| Failed | A count of unsuccessful payments and the total dollar amount of the unsuccessful payments in brackets. |
| Scheduled | A count of future scheduled payments and the total dollar amount of the future scheduled payments in brackets. |
| Refunds | A count of any payments that Biz Core has refunded to the customer and the total dollar amount of these refunds in brackets. |
| Active Claims | A count of any payments that are currently being [disputed](https://bizcore.refined.site/space/BCKB/1817444418/Direct+Debit+Claims+and+Cancellations#Claims) by the customers bank and in the [Under Claim](https://bizcore.refined.site/space/BCKB/1783890004/Records+%26+Statuses#Agreement-Statuses) status, and the total dollar amount of these claims in brackets. |
| Claims History | A count of any payments that have been [disputed](https://bizcore.refined.site/space/BCKB/1817444418/Direct+Debit+Claims+and+Cancellations#Claims), including when the dispute has either been successful or unsuccessful, and the total dollar amount of any successful and unsuccessful claims in brackets. |
| Successful Claims | A count of payments that have been successfully [disputed](https://bizcore.refined.site/space/BCKB/1817444418/Direct+Debit+Claims+and+Cancellations#Claims) and returned to the customer, and the total dollar amount of any successful claims in brackets. |
| Cancellations | A count of the number of times the Agreement has been switched to the [Cancelled status](https://bizcore.refined.site/space/BCKB/1817444418/Direct+Debit+Claims+and+Cancellations#Cancellations-(AKA-Payment-Stop)). |

# **Record Toolbar**

Along to top of each Agreement Record is the Record Toolbar, providing tools and features for managing the Agreement:

![image](media://77d7c5ea-8955-4d3b-ade4-5366916bc12c)

| **Tool** | **Description** |
| --- | --- |
| ![image](media://d4784756-8654-45bf-8afe-792bcd6ef304) | Clicking this icon will add a direct URL link of the Agreement Record to the user's clipboard, allowing them to share it or access the Agreement directly. |
| ![image](media://bc8e065c-f57e-419e-974b-3e3af23f3946) | Clicking this icon will refresh the Agreement Record, updating it to display the most recent information and ensuring real-time data accuracy. |
| ![image](media://81ff4e25-d76b-40b5-8b65-d3ec643272fd) | Users can click this icon to add a note to the Agreement Record, these will be added to the [Messages tab of the Side Panel](https://bizcore.refined.site/space/BCKB/1783857153/Side+Panel#Messages). |
| ![image](media://427bc078-0724-4cfc-9e7d-452dc5618ac4) | Clicking this icon will open the [Reminders tab of the Side Panel](https://bizcore.refined.site/space/BCKB/1783857153/Side+Panel#Reminders), allowing the user to add or manage reminders for the Agreement. |
| ![image](media://445883ba-cda0-4b6a-a0f6-86e30b75a97c) | Clicking this icon will launch the document upload wizard, allowing users to upload documents, images or files to be stored in the [Documents tab of the Agreement’s Side Panel](https://bizcore.refined.site/space/BCKB/1783857153/Side+Panel#Documents). After launching the wizard users can click the **Choose files** button or drag and drop files into the **Drop Zone**, before clicking **Upload All** to add them to the record. |
| ![image](media://f07cef18-4a4e-445b-81ca-4c18f913e35a) | Users can click this icon to send a PDF payment summary to the customer’s email address. This provides a breakdown of the Agreement, including completed, processing, failed and scheduled transactions. The generated payment summary is also automatically stored in the [Documents tab of the Agreement’s Side Panel](https://bizcore.refined.site/space/BCKB/1783857153/Side+Panel#Documents). |
| ![image](media://9a559d70-6b04-4da0-af5c-998e51ee90e8) | Users can click this icon to send an email and SMS to the customer, allowing them to  supply their bank account or card details to be used as the [Agreement Transaction Source](https://bizcore.refined.site/space/BCKB/2009366547/Types+of+Payment+Agreement%C2%A0Authorisations#2---Agreement-Source-Authorisation).<br>> ℹ️ Card payment integration is required. To enable this feature, please contact [support@bizcore.com.au](mailto:support@bizcore.com.au) |
| ![image-20240617-022905.png](media://d91154bc-56da-457c-ba53-64c2a791e5a6) | Clicking this icon will launch a popup for users to send an SMS and/or email to the customer, requesting a card payment. Users can enter a specific amount to be paid, or leave the **Amount **field blank to allow the customer to specify their card payment amount.<br>> ℹ️ Card payment integration is required. To enable this feature, please contact [support@bizcore.com.au](mailto:support@bizcore.com.au) |
| ![image](media://ad84905f-520d-45a8-b04e-410eda07edc3) | Clicking this icon will launch a popup to manually add scheduled payments for the Agreement. Within the popup wizard users can [add recurring or once-off scheduled payments](https://bizcore.refined.site/space/BCKB/1952972873/How+to+Change+Payments) to the Agreement Ledger. |
| ![image](media://817f32d0-0162-4d8d-8314-4e8233ae02ee) | Clicking this icon will allow users to delete all future scheduled payments from the Agreement Ledger. |
| ![image-20241114-003530.png](media://4a9ba097-c340-43eb-9f61-74ae23843b26) | Clicking this icon will send the Customer an email containing receipts for all completed transactions. The receipts will also be stored in the [Messages tab of the Side Panel](https://bizcore.refined.site/space/BCKB/1783857153/Side+Panel#Messages). More information about [Payment Receipts can be found here](https://fsoftsolutions.atlassian.net/wiki/spaces/BCKB/pages/2391343108). |