Dunning notices

Dunning is the process of communicating with customers to collect overdue balances. A dunning notice is a notification sent to customers who have overdue invoices. To learn more, see Dunning notices in the Sage Intacct Help Center.

List dunning notices

get/objects/accounts-receivable/dunning-notice

Returns a collection with a key, ID, and link for each dunning notice. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/accounts-receivable/dunning-notice/1"
      },
    • {
      • "key": "4",
      • "id": "4",
      • "href": "/objects/accounts-receivable/dunning-notice/4"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/accounts-receivable/dunning-notice/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/accounts-receivable/dunning-notice/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 4,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a dunning notice
post/objects/accounts-receivable/dunning-notice
Creates a new dunning notice.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
basedOn
required
string
Specifies how to filter due invoices, either by the invoice date or the due date.


 Enum: "dueDate" "invoiceDate"  
 Example:  "dueDate"
asOfDate
required
string <date> 
Specifies the date to use to determine when invoices are filtered. For example, if you set an asOfDate of 2025-06-15 and you set the basedOnDate to dueDate, notices are sent to customers who have invoices due by 2025-06-15.


 
 Example:  "2025-01-01"
printTemplateName
required
string
Name of the printed document template to use for the dunning notice.


 
 Example:  "L1 DL Doc Template"
required
object
 
key
string
Unique key for the dunning level.


 
 Example:  "100"
id
string
Name or other unique ID for the dunning level.


 
 Example:  "L1"
key
string
System-assigned unique key for the dunning notice.


 
 Example:  "23"
object
Information about the user who is the sender.


 
email
required
string
Sender email address.


 
 Example:  "[email protected]"
name
string
Sender name.


 
 Example:  "John Bow"
phone
string
Sender phone number.


 
 Example:  "123-456-7890"
attachInvoice
boolean
 Default:  false
Specifies whether invoices are attached to the dunning notice.


 
 Example:  false
object
Email template for the dunning notice.


 
key
string or null
Unique key for the email template.


 
 Example:  "23"
id
string or null
Name or other unique ID for the email template.


 
 Example:  "L1 DL template"
Array of objects
List of customers included in the dunning notice.


 
 Array 
sendPrintedNotice
required
boolean
 Default:  true
Specifies whether to print a dunning notice for the customer.


 
 Example:  true
required
object
Customer associated with the dunning notice.


 
id
string
Unique ID for the dunning customer. This value is the same as the key for this object.


 
 Example:  "12"
object
Dunning notice email details.


 
deliveryMethod
string
Delivery method for the dunning notice.


 Enum: "both" "emailed" "printed"  
 Example:  "both"
sendEmailNotice
boolean
 Default:  true
Specifies whether to send a dunning email notification to the email addresses listed in noticeEmail.


 
 Example:  true
Array of objects
List of invoices included in the dunning notice.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "basedOn": "dueDate",
  • "asOfDate": "2025-04-18",
  • "dunningLevel": {
    • "id": "L1"
    },
  • "printTemplateName": "L1 DL Doc Template",
  • "dunningCustomers": [
    • {
      • "customer": {
        },
      • "noticeEmail": {},
      • "sendPrintedNotice": false,
      • "sendEmailNotice": false
      },
    • {
      • "customer": {
        },
      • "noticeEmail": {},
      • "sendPrintedNotice": false,
      • "sendEmailNotice": false
      }
    ],
  • "sender": {}
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "11",
    • "key": "11",
    • "href": "/objects/accounts-receivable/dunning-notice/11"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a dunning notice
get/objects/accounts-receivable/dunning-notice/{key}
Returns detailed information for a specified dunning notice.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the dunning notice.


 
 Example:  11
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "48",
    • "key": "48",
    • "dunningLevel": {
      • "key": "12",
      • "id": "L1",
      • "href": "/objects/accounts-receivable/dunning-level/12"
      },
    • "basedOn": "dueDate",
    • "currency": "USD",
    • "baseCurrency": "USD",
    • "asOfDate": "2025-04-18",
    • "printTemplateName": "L1 DL Doc Template",
    • "emailTemplate": {
      • "key": null,
      • "id": null
      },
    • "attachInvoice": false,
    • "sender": {},
    • "audit": {
      • "createdDateTime": "2025-05-09T10:14:21Z",
      • "modifiedDateTime": "2025-05-09T10:14:21Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "dunningCustomers": [
      • {
        }
      ],
    • "href": "/objects/accounts-receivable/dunning-notice/48"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}