Recurring document subtotals

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

List recurring document subtotals

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

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "7",
      • "id": "7",
      • "href": "/objects/order-entry/recurring-document-subtotal/7"
      },
    • {
      • "key": "8",
      • "id": "8",
      • "href": "/objects/order-entry/recurring-document-subtotal/8"
      },
    • {
      • "key": "1520",
      • "id": "1520",
      • "href": "/objects/order-entry/recurring-document-subtotal/15"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get a recurring document subtotal

get/objects/order-entry/recurring-document-subtotal/{key}

Returns detailed information for a specified recurring document subtotal.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned unique key for the recurring document subtotal.

Example: 99
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "1520",
    • "key": "1520",
    • "recurringDocumentHeader": {
      • "key": "6",
      • "id": "6",
      • "documentType": "Sales Invoice",
      • "href": "/objects/order-entry/recurring-document::Sales%20Invoice/6"
      },
    • "description": "Sales Tax",
    • "absoluteValue": "80.45",
    • "percentValue": "8.25",
    • "total": "80.45000000000000",
    • "dimensions": {
      • "location": {
        },
      • "customer": {
        }
      },
    • "txnAbsoluteValue": "80.45",
    • "txnTotal": "80.45000000000000",
    • "href": "/objects/order-entry/recurring-document-subtotal/1520"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}