Customer totals

Provides information about the total amount due from a customer.

List customer totals

get/objects/accounts-receivable/customer-total

Returns a collection with a key, ID, and link for each customer total. This operation is mostly for use in testing; use the query service 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": "41",
      • "id": "15",
      • "href": "/objects/accounts-receivable/customer-total/41"
      },
    • {
      • "key": "44",
      • "id": "6",
      • "href": "/objects/accounts-receivable/customer-total/44"
      },
    • {
      • "key": "46",
      • "id": "3",
      • "href": "/objects/accounts-receivable/customer-total/46"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a customer total
get/objects/accounts-receivable/customer-total/{key}
Returns detailed information for a specified customer total.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the customer total.


 
 Example:  42
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "43",
    • "customer": {
      • "id": "DS",
      • "name": "Decal Solutions",
      • "key": "5",
      • "href": "/objects/accounts-receivable/customer/5"
      },
    • "entity": {
      • "id": "NYC",
      • "name": "New York City"
      },
    • "totalDue": "123.11",
    • "id": "5",
    • "href": "/objects/accounts-receivable/customer-total/43"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}