Document subtotals

Details of subtotals, taxes, discounts, charges, and more for an Order Entry transaction.

List document subtotals

get/objects/order-entry/document-subtotal

Returns a collection with a key, ID, and link for each Order Entry 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
SubscriptionOrder Entry
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Order Entry documents
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "13",
      • "id": "13",
      • "href": "/objects/order-entry/document-subtotal/13"
      },
    • {
      • "key": "14",
      • "id": "14",
      • "href": "/objects/order-entry/document-subtotal/14"
      },
    • {
      • "key": "15",
      • "id": "15",
      • "href": "/objects/order-entry/document-subtotal/15"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100
    }
}
Get a document subtotal
get/objects/order-entry/document-subtotal/{key}
Returns detailed information for a specified Order Entry document subtotal.



Permissions and other requirements



SubscriptionOrder Entry


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Order Entry documents







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


 
 Example:  15
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "307",
    • "key": "307",
    • "description": "Sales Discount",
    • "absoluteValue": "14.5",
    • "percentValue": "1.45",
    • "total": "-14.5",
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "customer": {
        }
      },
    • "txnAbsoluteValue": "14.5",
    • "txnTotal": "-14.5",
    • "documentLine": {
      • "id": "233",
      • "key": "233",
      • "documentType": "Sales Invoice",
      • "href": "/objects/order-entry-document-line::Sales%20Invoice/233"
      },
    • "documentHeader": {
      • "key": "21",
      • "id": "Sales Invoice-SUBINV#0100#doc",
      • "documentType": "Sales Invoice",
      • "href": "/objects/order-entry-document::Sales%20Invoice/21"
      },
    • "audit": {
      • "createdDateTime": "2024-07-11T04:58:20Z",
      • "modifiedDateTime": "2024-07-11T04:58:20Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/order-entry/document-subtotal/307"
    },
  • "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


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
    }
}