Bill summaries

Bill summaries are collections of the same type of transactions, grouped together for processing.

List bill summaries

get/objects/accounts-payable/bill-summary

Returns a collection with a key, ID, and link for each bill 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": "94",
      • "id": "94",
      • "href": "/objects/accounts-payable/bill-summary/94"
      },
    • {
      • "key": "96",
      • "id": "96",
      • "href": "/objects/accounts-payable/bill-summary/96"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a bill summary
get/objects/accounts-payable/bill-summary/{key}
Returns detailed information for a specified bill summary.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "98",
    • "key": "98",
    • "name": "Bills: 2022/08/02 Batch",
    • "glPostingDate": "2022-08-02",
    • "status": "active",
    • "recordType": "apBill",
    • "totalAmount": "100.23",
    • "state": "open",
    • "parent": {
      • "id": null,
      • "key": null
      },
    • "preventGLPosting": false,
    • "bankAccountId": {
      • "id": null,
      • "key": null
      },
    • "summaryCreationType": "Auto-Summary",
    • "isQuickPaymentSummary": false,
    • "href": "/objects/accounts-payable/bill-summary/98"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}