Vendor totals

A vendor total object provides information about how much is owed to a vendor.

List vendor totals

get/objects/accounts-payable/vendor-total

Returns a collection with a key, ID, and link for each vendor 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": "85",
      • "id": "111",
      • "href": "/objects/accounts-payable/vendor-total/85"
      },
    • {
      • "key": "86",
      • "id": "113",
      • "href": "/objects/accounts-payable/vendor-total/86"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a vendor total
get/objects/accounts-payable/vendor-total/{key}
Returns detailed information for a specified vendor total.


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


 
 Example:  86
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "85",
    • "vendor": {
      • "id": "202",
      • "name": "Pac Bell",
      • "key": "48",
      • "href": "/objects/accounts-payable/vendor/48"
      },
    • "entity": {
      • "id": "1",
      • "name": "United States"
      },
    • "totalDue": "1400.00",
    • "id": "48",
    • "href": "/objects/accounts-payable/vendor-total/85"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}