Payment summaries

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

List payment summaries

get/objects/accounts-receivable/payment-summary

Returns a collection with a key, ID, and link for each payment summary.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  "Reversed Receipts(Bank-BOA): 2023/04/12 Batch"
glPostingDate
required
string or null <date> 
The date summary items post to the general ledger.


 
 Example:  "2023-04-12"
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 payment summary.


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


 
 Example:  "13"
id
string or null
Identifier for the parent.


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


 
 Example:  false
object
Bank account ID.


 
id
string
Identifier for the bank account.


 
 Example:  "BOA"
currency
string
The currency for this bank account.


 
 Example:  "USD"
object
The GL undeposited funds account to use when accumulating payment summary. This account is required if a 'bankAccount' is not specified.


 
key
string or null
System-assigned key for the undeposited funds account.


 
 Example:  "33"
id
string or null
General ledger undeposited funds account number.


 
 Example:  "1070"
isQuickPaymentSummary
boolean
 Default:  false
This field is set to true only for manual and quick payment summaries. Default is false.


 
 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": "Reversed Receipts(Bank-BOA): 2023/04/12 Batch",
  • "glPostingDate": "2024-06-18",
  • "status": "active",
  • "state": "open",
  • "preventGLPosting": false,
  • "bankAccount": {
    • "id": "BOA"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "110",
    • "id": "110",
    • "href": "/objects/accounts-receivable/payment-summary/110"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a payment summary
get/objects/accounts-receivable/payment-summary/{key}
Returns detailed information for a specified payment summary.


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "110",
    • "id": "110",
    • "name": "Reversed Receipts(Bank-BOA): 2023/04/12 Batch",
    • "glPostingDate": "2023-04-12",
    • "status": "active",
    • "recordType": "payment",
    • "totalAmount": "200",
    • "state": "open",
    • "parent": {
      • "key": null,
      • "id": null
      },
    • "preventGLPosting": false,
    • "bankAccount": {
      • "key": "1",
      • "id": "BOA",
      • "currency": "USD",
      • "href": "/objects/cash-management/bank-account/1"
      },
    • "undepositedGLAccount": {
      • "id": "1070",
      • "key": "33",
      • "href": "/objects/general-ledger/account/33"
      },
    • "summaryCreationType": "manual",
    • "isQuickPaymentSummary": false,
    • "entity": {
      • "key": "1",
      • "id": "1",
      • "name": "United States of America",
      • "href": "/objects/company-config/entity/1"
      },
    • "audit": {
      • "createdDateTime": "2024-09-09T06:35:58Z",
      • "modifiedDateTime": "2024-09-09T06:35:58Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/accounts-receivable/payment-summary/110"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a payment summary
patch/objects/accounts-receivable/payment-summary/{key}
Updates an existing payment summary by setting field values. Any fields not provided remain unchanged.


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


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


 
 Example:  "Reversed Receipts(Bank-BOA): 2023/04/12 Batch"
glPostingDate
string or null <date> 
The date summary items post to the general ledger.


 
 Example:  "2023-04-12"
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 payment summary.


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


 
 Example:  "13"
id
string or null
Identifier for the parent.


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


 
 Example:  false
object
Bank account ID.


 
id
string
Identifier for the bank account.


 
 Example:  "BOA"
currency
string
The currency for this bank account.


 
 Example:  "USD"
object
The GL undeposited funds account to use when accumulating payment summary. This account is required if a 'bankAccount' is not specified.


 
key
string or null
System-assigned key for the undeposited funds account.


 
 Example:  "33"
id
string or null
General ledger undeposited funds account number.


 
 Example:  "1070"
isQuickPaymentSummary
boolean
 Default:  false
This field is set to true only for manual and quick payment summaries. Default is false.


 
 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": "paybatch 02",
  • "glPostingDate": "2024-06-19",
  • "status": "active",
  • "state": "open"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "110",
    • "id": "110",
    • "href": "/objects/accounts-receivable/payment-summary/110"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a payment summary
delete/objects/accounts-receivable/payment-summary/{key}
Deletes a payment summary.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the payment 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
    }
}
Query payment summaries
post/services/core/query
Use the query service to find payment summaries that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}