Posted overpayments

Payments received that exceed the amount the customer owes are overpayments. Overpayments can be applied to future invoices or the excess can be returned to the customer.

List posted overpayments

get/objects/accounts-receivable/posted-over-payment

Returns a collection with a key, ID, and link for each posted overpayment.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
null
Get a posted overpayment
get/objects/accounts-receivable/posted-over-payment/{key}
Returns detailed information for a specified posted overpayment.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the posted overpayment.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
null
Query posted over payments
post/services/core/query
Use the query service to find posted over payments 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
    }
}