Document line subtotals

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

List document line subtotals

get/objects/order-entry/document-line-subtotal

Returns a collection with a key, ID, and link for each document line subtotal.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  104
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "22",
    • "key": "22",
    • "document": {
      • "id": "24",
      • "key": "24",
      • "href": "/objects/order-entry/document/24"
      },
    • "description": "1) G1 Goods and Services Tax",
    • "absoluteValue": "11.00000000",
    • "percentValue": "10.00000000",
    • "total": null,
    • "status": "active",
    • "taxDetail": {
      • "key": "20",
      • "id": "G1 Goods and Services Tax",
      • "href": "/objects/tax/tax-detail/20"
      },
    • "dimensions": {
      • "location": {
        },
      • "department": {
        }
      },
    • "txnAbsoluteValue": "11.00000000",
    • "txnTotal": null,
    • "documentLine": {
      • "id": "10",
      • "key": "10",
      • "href": "/objects/order-entry/document-line/10"
      },
    • "enableOverrideTax": false,
    • "systemTaxDetail": {
      • "key": null,
      • "id": null
      },
    • "href": "/objects/order-entry/document-line-subtotal/22"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query document line subtotals
post/services/core/query
Use the query service to find document line subtotals 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
    }
}