Summaries

Summaries are collections of the same type of transactions, grouped together for processing. Summaries can be either opened or closed. Invoices, adjustments, and deposits can be added to open summaries.

List summaries

get/objects/accounts-receivable/summary

Returns a collection with a key, ID, and link for each AR 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.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/accounts-receivable/summary/2"
      },
    • {
      • "key": "6",
      • "id": "6",
      • "href": "/objects/accounts-receivable/summary/6"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a summary
post/objects/accounts-receivable/summary
Creates a new AR summary.


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


 
 Example:  "Invoices: 2019/12/01 Batch"
glPostingDate
required
string <date> 
The date summary items post to the general ledger.


 
 Example:  "2023-05-10"
recordType
required
string
 Default:  "invoice"
This determines the type of transaction that the summary contains. Options Invoice (ri), Adjustment (ra), Payments (rp), ManualDeposit (ri/rp), Discounts (rd).


 Enum: "adjustment" "discount" "invoice" "overpayment" "payment"  
 Example:  "invoice"
status
required
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"
state
string
 Default:  "open"
State of the summary, which can be open or closed. An open summary can have items added to it.


 Enum: "closed" "open"  
 Example:  "open"
object
Parent of the AR summary.


 
key
string
System-assigned key for the parent.


 
 Example:  "11"
id
string
Identifier for the parent.


 
 Example:  "11"
preventGLPosting
boolean
 Default:  false
Set to true to prevent posting summary items to the general ledger.


 
 Example:  false
isQuickPaymentSummary
boolean
 Default:  false
This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type invoice/adjustment.


 
 Example:  false
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "name": "Invoices: 2019/12/01 Batch",
  • "glPostingDate": "2023-05-10",
  • "status": "active",
  • "recordType": "invoice",
  • "state": "open",
  • "preventGLPosting": false,
  • "isQuickPaymentSummary": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "14",
    • "id": "14",
    • "href": "/objects/accounts-receivable/summary/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a summary
get/objects/accounts-receivable/summary/{key}
Returns detailed information for a specified AR summary.


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


 
 Example:  173
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "14",
    • "id": "14",
    • "name": "Invoices: 2019/12/01 Batch",
    • "glPostingDate": "2019-12-01",
    • "status": "active",
    • "recordType": "invoice",
    • "totalAmount": "100",
    • "state": "open",
    • "parent": {
      • "id": "11",
      • "key": "11"
      },
    • "preventGLPosting": false,
    • "summaryCreationType": "manual",
    • "isQuickPaymentSummary": false,
    • "href": "/objects/accounts-receivable/summary/14",
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a summary
patch/objects/accounts-receivable/summary/{key}
Updates an existing AR summary by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  173
Request Body schema: application/json
name
string
Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application.


 
 Example:  "Invoices: 2019/12/01 Batch"
glPostingDate
string <date> 
The date summary items post to the general ledger.


 
 Example:  "2023-05-10"
recordType
string
 Default:  "invoice"
This determines the type of transaction that the summary contains. Options Invoice (ri), Adjustment (ra), Payments (rp), ManualDeposit (ri/rp), Discounts (rd).


 Enum: "adjustment" "discount" "invoice" "overpayment" "payment"  
 Example:  "invoice"
state
string
 Default:  "open"
State of the summary, which can be open or closed. An open summary can have items added to it.


 Enum: "closed" "open"  
 Example:  "open"
object
Parent of the AR summary.


 
key
string
System-assigned key for the parent.


 
 Example:  "11"
id
string
Identifier for the parent.


 
 Example:  "11"
preventGLPosting
boolean
 Default:  false
Set to true to prevent posting summary items to the general ledger.


 
 Example:  false
isQuickPaymentSummary
boolean
 Default:  false
This field is set to true only for manual and quick payment summaries. It is set to false for transactions of type invoice/adjustment.


 
 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": "Invoices: 2019/12/01 Batch",
  • "glPostingDate": "2023-05-10",
  • "status": "active",
  • "recordType": "invoice",
  • "state": "open",
  • "preventGLPosting": false,
  • "isQuickPaymentSummary": false
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "14",
    • "id": "14",
    • "href": "/objects/accounts-receivable/summary/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a summary
delete/objects/accounts-receivable/summary/{key}
Deletes an AR summary.


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


 
 Example:  173
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
    }
}
Query summaries
post/services/core/query
Use the query service to find summaries that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples