Document histories

An Order Entry document history contains one entry for each existing transaction in the workflow associated with the selected transaction.

List document histories

get/objects/order-entry/document-history

Returns a collection with a key, ID, and link for each Order Entry document history.

SecurityOAuth2
Responses
200

OK

400

Bad Request

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


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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "411",
    • "key": "411",
    • "convertedTo": {
      • "key": "483",
      • "id": "Sales Invoice-SUBINV#0200#doc",
      • "documentType": "Sales Invoice",
      • "href": "/objects/order-entry-document::Sales%20Invoice/483"
      },
    • "convertedFrom": {
      • "key": "482",
      • "id": "Sales Order-SO0037",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry-document::Sales%20Order/482"
      },
    • "orderEntryDocument": {
      • "key": "482",
      • "id": "Sales Order-SO0037",
      • "documentType": "Sales Order",
      • "href": "/objects/order-entry-document::Sales%20Order/482"
      },
    • "href": "/objects/order-entry/document-history/411"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Query document histories
post/services/core/query
Use the query service to find document histories 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
    }
}