Document subtotals

Details of subtotals, taxes, discounts, charges, and more for a purchasing transaction.

List document subtotals

get/objects/purchasing/document-subtotal

Returns a collection with a key, ID, and link for each purchasing document subtotal. This operation is mostly for use in testing; use query to find objects that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionPurchasing
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Purchasing documents
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/purchasing/document-subtotal/13"
      },
    • {
      • "key": "14",
      • "id": "14",
      • "href": "/objects/purchasing/document-subtotal/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Get a document subtotal
get/objects/purchasing/document-subtotal/{key}
Returns detailed information for a specified purchasing document subtotal.



Permissions and other requirements



SubscriptionPurchasing


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Purchasing documents







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the document subtotal.


 
 Example:  14
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "14",
    • "key": "14",
    • "documentHeader": {
      • "key": "73",
      • "documentType": "Vendor Invoice",
      • "href": "/objects/purchasing/document::Vendor%20Invoice/73"
      },
    • "description": "Purchase Tax",
    • "absoluteValue": "7.80",
    • "percentValue": "8.00",
    • "total": "7.80",
    • "dimensions": {
      • "location": {
        }
      },
    • "txnAbsoluteValue": "7.80",
    • "txnTotal": "7.80",
    • "documentLine": {
      • "id": "53",
      • "key": "53",
      • "documentType": "Vendor Invoice",
      • "href": "/objects/purchasing/document-line::Vendor%20Invoice/53"
      },
    • "audit": {
      • "createdDateTime": "2024-05-27T06:22:06Z",
      • "modifiedDateTime": "2024-05-27T06:22:09Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/purchasing/document-subtotal/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query document subtotals
post/services/core/query
Use the query service to find document subtotals that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


Request samples