Summaries

Summaries are collections of the same type of transactions grouped together for processing. To learn more, see Accounts Payable summary overview in the Sage Intacct Help Center.

List summaries

get/objects/accounts-payable/summary

Returns a collection with a key, ID, and link for each summary. 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": "36",
      • "id": "36",
      • "href": "/objects/accounts-payable/summary/36"
      },
    • {
      • "key": "43",
      • "id": "43",
      • "href": "/objects/accounts-payable/summary/43"
      },
    • {
      • "key": "55",
      • "id": "55",
      • "href": "/objects/accounts-payable/summary/55"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a summary
post/objects/accounts-payable/summary
Creates a new summary.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
name
required
string
Name for the AP summary. The system uses this name to identify the summary throughout the Accounts Payable application.


 
 Example:  "Jan 2024 Bill Summary"
glPostingDate
required
string <date> 
The date that items in the summary should post to the general ledger.


 
 Example:  "2024-06-02"
summaryType
string
 Default:  "apBill"
Record type for AP summary


 Enum: "apAdjustment" "apBill"  
 Example:  "apBill"
object
Parent summary


 
key
string or null
System-assigned key for the parent summary.


 
 Example:  "23"
id
string or null
Unique identifier for the parent summary.


 
 Example:  "23"
isQuickPaymentSummary
boolean
 Default:  false
Set to 'true' for manual and quick payment summary types. Set to 'false' for bill and adjustment summary types.


 
 Example:  false
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
{
  • "name": "Jan Summary 2024",
  • "glPostingDate": "2024-02-01",
  • "status": "active",
  • "recordType": "apBill"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "56",
    • "id": "56",
    • "href": "/objects/accounts-payable/summary/56"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a summary
get/objects/accounts-payable/summary/{key}
Returns detailed information for a specified summary.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "36",
    • "key": "36",
    • "name": "Bills: Jan Summary 2024",
    • "glPostingDate": "2024-02-01",
    • "status": "active",
    • "recordType": "apBill",
    • "totalAmount": "4000.23",
    • "state": "open",
    • "parent": {
      • "id": null,
      • "key": null
      },
    • "preventGLPosting": false,
    • "summaryCreationType": "manual",
    • "isQuickPaymentSummary": false,
    • "entity": {
      • "key": "46",
      • "id": "Western Region",
      • "name": "Western Region",
      • "href": "/objects/company-config/entity/46"
      },
    • "href": "/objects/accounts-payable/summary/36"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a summary
patch/objects/accounts-payable/summary/{key}
Updates an existing summary by setting field values. Any fields not provided remain unchanged. 


You can change the name, GL posting date, and status of manual summaries. Summaries that are created by Sage Intacct (system summaries) cannot be edited.


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


 
 Example:  99
Request Body schema: application/json
name
string
Name for the AP summary. The system uses this name to identify the summary throughout the Accounts Payable application.


 
 Example:  "Jan 2024 Bill Summary"
glPostingDate
string <date> 
The date that items in the summary should post to the general ledger.


 
 Example:  "2024-06-02"
summaryType
string
 Default:  "apBill"
Record type for AP summary


 Enum: "apAdjustment" "apBill"  
 Example:  "apBill"
object
Parent summary


 
key
string or null
System-assigned key for the parent summary.


 
 Example:  "23"
id
string or null
Unique identifier for the parent summary.


 
 Example:  "23"
isQuickPaymentSummary
boolean
 Default:  false
Set to 'true' for manual and quick payment summary types. Set to 'false' for bill and adjustment summary types.


 
 Example:  false
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
{
  • "name": "Sep To Oct 2024 Summary",
  • "glPostingDate": "2024-11-01",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "id": "50",
    • "key": "50",
    • "href": "/objects/accounts-payable/summary/50"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a summary
delete/objects/accounts-payable/summary/{key}
Deletes a summary. Only summaries with an open status that do not contain any transactions can be deleted.


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


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