Integrate
Integrate v2
Integrate v2
  • Getting Started
    • 🤝Authorisation & Activation
    • 🔗API v2 URL
    • 🔢Versioning
    • 🔐Authentication
    • 🟰Additional Headers
    • 🆗Response Status Codes
    • 🛑Rate Limiting
    • ⁉️Errors and Bad Requests
    • 📖Pagination
    • ⏭️Upgrading to v2
  • Reference
    • Settings
      • Client Integrations
        • Get Client Integrations
        • Change Client Integration State
    • Finance+
      • Debt Management
        • Debtor Notes
          • Get Communication Type(s)
          • Get Note Type(s)
          • Get Note(s)
          • Create Note
          • Update Note
          • Delete Note
          • Get Promise To Pay Record(s)
          • Delete Promise To Pay
        • Age Analysis Report
        • Financial Transactions Report
        • Get Schools
        • Get Accountable Person(s)
        • Get Learner(s)
        • Get Transaction Type(s)
        • Get Transaction Category(s)
Powered by GitBook
On this page
  • Overview
  • Debtor Notes API Calls
  1. Reference
  2. Finance+
  3. Debt Management

Debtor Notes

PreviousDebt ManagementNextGet Communication Type(s)

Overview

The Debtor Notes API allows you to create, update, or delete debtor notes. This includes different types of notes, such as Internal Notes, Text Notes, and Promise to Pay arrangements (see the page for more information).

  • Create / Update a Debtor Note: Use the Debtor Notes API to add or modify a note. This applies to all note types, including Promise to Pay arrangements.

  • Delete a Debtor Note: Standard debtor notes can be deleted using the Debtor Notes API.

  • Deleting Promise to Pay Arrangements:

    • Promise to Pay arrangements are created and updated as part of a debtor note.

    • However, to delete individual Promise to Pay arrangements from a note, you must use the separate Delete Promise to Pay API call.

Debtor Notes API Calls

Get Note Types
Get Communication Type(s)
Get Note Type(s)
Get Note
Update Note
Delete Note
Get Promise to Pay(s)
Delete Promise to Pay