Dunning levels

Dunning is the process of communicating with customers to collect overdue balances. Dunning levels define the levels of notices that are sent during the collection process. To learn more, see Dunning notices in the Sage Intacct Help Center.

List dunning levels

get/objects/accounts-receivable/dunning-level

Returns a collection with a key, ID, and link for each dunning level. 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": "2",
      • "id": "DL1",
      • "href": "/objects/accounts-receivable/dunning-level/2"
      },
    • {
      • "key": "5",
      • "id": "Dunning level",
      • "href": "/objects/accounts-receivable/dunning-level/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a dunning level
post/objects/accounts-receivable/dunning-level
Creates a new dunning level. Use naming conventions to establish levels for different customer types, company entities, and amount owed ranges. To learn more, see Add dunning levels in the Sage Intacct Help Center.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name or other unique identifier for the dunning level.


 
 Example:  "L1 Dunning level"
object
The printed document template assigned to the dunning level.


 
id
required
string
Unique identifier for printed document template.


 
 Example:  "Level 1 Document Template"
key
string
Unique key for printed document template.


 
 Example:  "24"
object
 
minDays
required
integer
 Default:  0
Minimum days overdue. This is the lower value for the days overdue range of the dunning level.


 
 Example:  10
txnCurrency
required
string
Transaction currency for the invoice amount.


 
 Example:  "USD"
maxDays
integer
Maximum days overdue. This is the higher value for the days overdue range of the dunning level.


 
 Example:  100
minAmount
string <decimal-precision-2> 
Minimum invoice amount. This is the lower value for the invoice amount overdue range of the dunning level.


 
 Example:  "100"
maxAmount
string <decimal-precision-2> 
Maximum invoice amount. This is the higher value for the invoice amount overdue range of the dunning level.


 
 Example:  "5000"
baseCurrency
string
Base currency for the invoice amount.


 
 Example:  "USD"
object
Sets how dunning notices are sequentially numbered when they're created.


 
id
required
string
Name or other unique ID for the numbering sequence.


 
 Example:  "L1 Dunning Sequence"
object
The email template assigned to the dunning level.


 
key
string
Unique key for the email template.


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


 
 Example:  "L1 Dunning email template"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "L1 Dunning level",
  • "dunningThreshold": {
    • "minDays": 0,
    • "maxDays": 100,
    • "txnCurrency": "USD"
    },
  • "printTemplate": {
    • "id": "L1 PWD Dunning Notice"
    },
  • "noticeSequence": {
    • "id": "AR-Cr"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "L1 Dunning level",
    • "href": "/objects/accounts-receivable/dunning-level/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a dunning level
get/objects/accounts-receivable/dunning-level/{key}
Returns detailed information for a specified dunning level.


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


 
 Example:  4
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "DL1",
    • "dunningThreshold": {
      • "minDays": 0,
      • "maxDays": 100,
      • "minAmount": "1000",
      • "maxAmount": "10000",
      • "baseCurrency": "USD",
      • "txnCurrency": "USD"
      },
    • "printTemplate": {
      • "key": "2000492",
      • "id": "DL1 Dunning Notice"
      },
    • "emailTemplate": {
      • "key": "3",
      • "id": "DL1 PWD template",
      • "href": "/objects/company-config/email-template/3"
      },
    • "noticeSequence": {
      • "id": "Ar-Rec"
      },
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2025-05-21T09:05:50Z",
      • "modifiedDateTime": "2025-05-21T09:05:50Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "href": "/objects/accounts-receivable/dunning-level/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a dunning level
patch/objects/accounts-receivable/dunning-level/{key}
Updates an existing dunning level by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  4
Request Body schema: application/json
object
The printed document template assigned to the dunning level.


 
key
string
Unique key for printed document template.


 
 Example:  "24"
id
string
Unique identifier for printed document template.


 
 Example:  "Level 1 Document Template"
object
 
minDays
integer
 Default:  0
Minimum days overdue. This is the lower value for the days overdue range of the dunning level.


 
 Example:  10
maxDays
integer
Maximum days overdue. This is the higher value for the days overdue range of the dunning level.


 
 Example:  100
minAmount
string <decimal-precision-2> 
Minimum invoice amount. This is the lower value for the invoice amount overdue range of the dunning level.


 
 Example:  "100"
maxAmount
string <decimal-precision-2> 
Maximum invoice amount. This is the higher value for the invoice amount overdue range of the dunning level.


 
 Example:  "5000"
baseCurrency
string
Base currency for the invoice amount.


 
 Example:  "USD"
txnCurrency
string
Transaction currency for the invoice amount.


 
 Example:  "USD"
object
Sets how dunning notices are sequentially numbered when they're created.


 
id
string
Name or other unique ID for the numbering sequence.


 
 Example:  "L1 Dunning Sequence"
object
The email template assigned to the dunning level.


 
key
string
Unique key for the email template.


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


 
 Example:  "L1 Dunning email template"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "minDays": 10
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "4",
    • "id": "L2 Dunning level",
    • "href": "/objects/accounts-receivable/dunning-level/4"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a dunning level
delete/objects/accounts-receivable/dunning-level/{key}
Deletes a dunning level.


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


 
 Example:  4
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}