Document line subtotals

Details of the subtotals, taxes, discounts, charges, and more for the document line.

List document line subtotals

get/objects/purchasing/document-line-subtotal

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  15
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "14",
    • "key": "14",
    • "document": {
      • "id": "9",
      • "key": "9",
      • "documentType": "Contract Invoice",
      • "href": "/objects/purchasing/document::Contract%20Invoice/9"
      },
    • "description": "G10 Capital Acquisition",
    • "absoluteValue": "8.72000000",
    • "percentValue": "4.36000000",
    • "total": "8.72000000",
    • "status": "active",
    • "taxDetail": {
      • "key": "29",
      • "id": "SGST",
      • "href": "/objects/tax/tax-detail/29"
      },
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "project": {
        },
      • "class": {
        },
      • "item": {
        }
      },
    • "txnAbsoluteValue": "8.72000000",
    • "txnTotal": "8.72000000",
    • "documentLine": {
      • "id": "13",
      • "key": "13",
      • "documentType": "Contract Invoice",
      • "href": "/objects/purchasing/document-line::Contract%20Invoice/13"
      },
    • "enableOverrideTax": false,
    • "systemTaxDetail": {
      • "key": null,
      • "id": null
      },
    • "href": "/objects/purchasing/document-line-subtotal/14"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}