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.
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.
OK
Bad Request
{- "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
}
}
Creates a new AR summary.
name required | string Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. Example: "batch5" | ||||
glPostingDate required | string <date> The date summary items post to the general ledger. Example: "2023-05-10" | ||||
recordType required | string Options Invoice, Adjustment, QuickDeposit, Payments. This determines the type of transaction that the summary contains. Example: "ra" | ||||
status required | string Default: "active" Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced. Example: "active" | ||||
state | string State of the summary, which can be Example: "open" | ||||
object Parent of the AR summary. | |||||
| |||||
preventGLPosting | boolean Default: false Set to Example: false | ||||
object Detail of the bank accounts. | |||||
| |||||
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 |
Created
Bad Request
{- "name": "batch2",
- "glPostingDate": "2023-05-10",
- "status": "active",
- "recordType": "ri",
- "state": "open",
- "preventGLPosting": false,
- "isQuickPaymentSummary": false
}
{- "ia::result": {
- "key": "14",
- "id": "14",
- "href": "/objects/accounts-receivable/summary/14"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Returns detailed information for a specified AR summary.
key required | string System-assigned key for the summary. |
OK
Bad Request
{- "ia::result": {
- "key": "14",
- "id": "14",
- "name": "batch5",
- "glPostingDate": "2023-05-10",
- "status": "active",
- "recordType": "ra",
- "totalAmount": "100",
- "state": "open",
- "parent": {
- "id": "11",
- "key": "11"
}, - "preventGLPosting": false,
- "bankAccount": {
- "id": "13",
- "key": "13"
}, - "summaryCreationType": "manual",
- "isQuickPaymentSummary": false,
- "href": "/objects/accounts-receivable/summary/14"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Updates an existing AR summary by setting field values. Any fields not provided remain unchanged.
key required | string System-assigned key for the summary. |
name | string Name for the AR summary. The system uses this name to identify the summary throughout the Accounts Receivable application. Example: "batch5" | ||||
glPostingDate | string <date> The date summary items post to the general ledger. Example: "2023-05-10" | ||||
recordType | string Options Invoice, Adjustment, QuickDeposit, Payments. This determines the type of transaction that the summary contains. Example: "ra" | ||||
state | string State of the summary, which can be Example: "open" | ||||
object Parent of the AR summary. | |||||
| |||||
preventGLPosting | boolean Default: false Set to Example: false | ||||
object Detail of the bank accounts. | |||||
| |||||
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. Example: "active" |
OK
Bad Request
{- "name": "batch4",
- "glPostingDate": "2023-05-10",
- "status": "active",
- "recordType": "ra",
- "state": "open",
- "preventGLPosting": false,
- "isQuickPaymentSummary": false
}
{- "ia::result": {
- "key": "14",
- "id": "14",
- "href": "/objects/accounts-receivable/summary/14"
}, - "ia::meta": {
- "totalCount": 1,
- "totalSuccess": 1,
- "totalError": 0
}
}
Deletes an AR summary.
key required | string System-assigned key for the summary. |
No Content
Bad Request
{- "ia::error": {
- "code": "invalidRequest",
- "message": "Malformed URL",
- "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
- "details": [
- {
- "code": "invalidRequest",
- "message": "The content type is not valid",
- "correction": "TODO"
}
]
}
}
Queries an object for filtered data.
object | string Object type to query, in the form Example: "accounts-receivable/summary" | ||||||||
fields | Array of strings List of fields to include in the response. Can be any combination of these:
Example: ["key","id","max:vendor.creditLimit"] | ||||||||
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object) Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}] | |||||||||
Array Any of: Field value must be equal to this specified value. For date fields, you can use these macro values that are relative to the current date or the
These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the For example,
| |||||||||
filterExpression | string Default: "and" Logical operators to apply when there are multiple filter conditions. The conditions in the Shortcuts:
Example: "(1 and 2) or 3" | ||||||||
| |||||||||
Array of objects Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order. Example: [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}] | |||||||||
Array
| |||||||||
start | integer First record of the result set to include in the response. Example: 1 | ||||||||
size | integer Number of records to include in the response. Example: 100 |
OK
Bad Request
{- "object": "accounts-payable/vendor",
- "fields": [
- "id",
- "name",
- "status",
- "href"
], - "filters": [
- {
- "$eq": {
- "status": "active"
}
}, - {
- "$eq": {
- "billingType": "openItem"
}
}
], - "filterExpression": "1 and 2",
- "orderBy": [
- {
- "id": "asc"
}
]
}
{- "ia::result": [
- {
- "id": "Vend-00002",
- "name": "Test vendor",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/85"
}, - {
- "id": "VEND-00010",
- "name": "Design Works",
- "status": "active",
- "href": "/objects/accounts-payable/vendor/111"
}
], - "ia::meta": {
- "totalCount": 2,
- "start": 1,
- "pageSize": 100,
- "next": null,
- "previous": null
}
}