Check runs

Use a check run to process up to 1,000 checks at a time in an offline process. First create a check run, then add payment requests to the check run. A check run's configuration determines how the checks for the payments in a run are processed.

For more information, see Check run overview in the Sage Intacct Help Center.

List check runs

get/objects/accounts-payable/check-run

Returns a collection with a key, ID, and link for each check run. 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": "4",
      • "id": "All Checks For Mar 2025",
      • "href": "/objects/accounts-payable/check-run/4"
      },
    • {
      • "key": "2",
      • "id": "All Checks For Apr 2025",
      • "href": "/objects/accounts-payable/check-run/2"
      },
    • {
      • "key": "3",
      • "id": "All Checks For First week of March 2024",
      • "href": "/objects/accounts-payable/check-run/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a check run
post/objects/accounts-payable/check-run
Creates a new check run.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
title
string  <= 80 characters 
Name of the check run.


 
 Example:  "All Checks For Mar 2025"
sortOrder
Array of strings
 Default:  ["Check","Vendor","Entity"]
Sort order for the list of checks included in the check run.


 
 Example:  ["Check","Vendor","Entity"]
checksPerPage
string
 Default:  "1"
Number of checks to be printed per page.


 Enum: "1" "3"  
 Example:  "1"
printCheckStubDetail
boolean
 Default:  false
Indicates whether to add transaction details, such as bills or expenses paid with the check, to the check stub for your records.


 
 Example:  true
printVendorStubDetail
boolean
 Default:  false
Indicates whether to add transaction details, such as bills or expenses paid with the check, to the check stub for the vendor records.


 
 Example:  true
checkStock
string
 Default:  "blankCheckStockMicr"
Check stock used for printing. With the blankCheckStockMicr (blank check stock with MICR) option, checks can be printed from more that one checking account. With the prePrintedCheckStock (preprinted check stock) option, checks are printed from a single checking account.


 Enum: "blankCheckStockMicr" "prePrintedCheckStock"  
 Example:  "blankCheckStockMicr"
object
Checking account associated with the check run, which is required when the blankCheckStockMicr option is set for the checkStock field.


 
id
string
Checking account ID.


 
 Example:  "CITI"
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
{
  • "title": "All Checks For Mar 2025",
  • "checkStock": "prePrintedCheckStock",
  • "checkingAccount": {
    • "id": "BDF"
    },
  • "sortOrder": [
    • "Entity",
    • "Check",
    • "Vendor",
    • "Amount",
    • "Date",
    • "Bank"
    ],
  • "checksPerPage": "3",
  • "printCheckStubDetail": true,
  • "printVendorStubDetail": true,
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "6",
    • "key": "6",
    • "title": "All Checks For Mar 2025",
    • "href": "/objects/accounts-payable/check-run/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a check run
get/objects/accounts-payable/check-run/{key}
Returns detailed information for a specified check run.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the check run.


 
 Example:  6
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "6",
    • "key": "6",
    • "title": "First week Jan 2025",
    • "checkStock": "prePrintedCheckStock",
    • "checkingAccount": {
      • "id": "BDF"
      },
    • "sortOrder": [
      • "Entity",
      • "Check",
      • "Vendor",
      • "Amount",
      • "Date",
      • "Bank"
      ],
    • "checksPerPage": "3",
    • "printCheckStubDetail": true,
    • "printVendorStubDetail": true,
    • "status": "active",
    • "whenCreated": "2024-12-21",
    • "href": "/objects/accounts-payable/check-run/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a check run
patch/objects/accounts-payable/check-run/{key}
Updates an existing check run by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the check run.


 
 Example:  6
Request Body schema: application/json
title
string  <= 80 characters 
Name of the check run.


 
 Example:  "All Checks For Mar 2025"
sortOrder
Array of strings
 Default:  ["Check","Vendor","Entity"]
Sort order for the list of checks included in the check run.


 
 Example:  ["Check","Vendor","Entity"]
checksPerPage
string
 Default:  "1"
Number of checks to be printed per page.


 Enum: "1" "3"  
 Example:  "1"
printCheckStubDetail
boolean
 Default:  false
Indicates whether to add transaction details, such as bills or expenses paid with the check, to the check stub for your records.


 
 Example:  true
printVendorStubDetail
boolean
 Default:  false
Indicates whether to add transaction details, such as bills or expenses paid with the check, to the check stub for the vendor records.


 
 Example:  true
checkStock
string
 Default:  "blankCheckStockMicr"
Check stock used for printing. With the blankCheckStockMicr (blank check stock with MICR) option, checks can be printed from more that one checking account. With the prePrintedCheckStock (preprinted check stock) option, checks are printed from a single checking account.


 Enum: "blankCheckStockMicr" "prePrintedCheckStock"  
 Example:  "blankCheckStockMicr"
object
Checking account associated with the check run, which is required when the blankCheckStockMicr option is set for the checkStock field.


 
id
string
Checking account ID.


 
 Example:  "CITI"
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
{
  • "printCheckStubDetail": false,
  • "printVendorStubDetail": false,
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "title": "All Checks For Mar 2025",
    • "href": "/objects/accounts-payable/check-run/6"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a check run
delete/objects/accounts-payable/check-run/{key}
Deletes a check run. For more information about when check runs can be deleted, see Delete a check run in the Sage Intacct Help Center.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the check run.


 
 Example:  6
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
    }
}