Invoice summaries

Invoice summaries are collections of the same type of transactions grouped together for processing. AR invoice summaries can be either open or closed. Invoices can be added to open summaries.

List invoice summaries

get/objects/accounts-receivable/invoice-summary

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

Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Summaries
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/accounts-receivable/invoice-summary/9"
      },
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/accounts-receivable/invoice-summary/13"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an invoice summary

get/objects/accounts-receivable/invoice-summary/{key}

Returns detailed information for a specified AR invoice summary.

Permissions and other requirements
SubscriptionAccounts Receivable
User typeBusiness
PermissionsList, View Summaries
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the invoice summary.

Example: 65
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "key": "13",
    • "id": "13",
    • "name": "Invoices: 2019/12/01 Batch",
    • "glPostingDate": "2019-12-01",
    • "status": "active",
    • "recordType": "invoice",
    • "totalAmount": "0",
    • "state": "open",
    • "parent": {
      • "key": "13",
      • "id": "13"
      },
    • "preventGLPosting": false,
    • "summaryCreationType": "manual",
    • "isQuickPaymentSummary": false,
    • "href": "/objects/accounts-receivable/invoice-summary/13"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Query invoice summaries

post/services/core/query

Use the query service to find invoice summaries that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples