Transaction definition inventory total details

This object provides details about the inventory running total that will be affected by the transaction. Details include information about whether to track the quantity, value, or both, affected by the transaction and whether that amount will increase or decrease when the user saves the transaction.

List transaction definition inventory total detail objects

get/objects/purchasing-txn-definition-inventory-total-detail

Returns a collection with a key, ID, and link for each transaction definition inventory total detail object associated with the purchasing transaction definition.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "9",
      • "id": "9",
      • "href": "/objects/purchasing/txn-definition-inventory-total-detail/9"
      },
    • {
      • "key": "12",
      • "id": "12",
      • "href": "/objects/purchasing/txn-definition-inventory-total-detail/12"
      },
    • {
      • "key": "14",
      • "id": "14",
      • "href": "/objects/purchasing/txn-definition-inventory-total-detail/14"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a transaction definition inventory total detail object
post/objects/purchasing-txn-definition-inventory-total-detail
Creates a new transaction definition inventory total detail object.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
maintainType
required
string
Specify whether to track the quantity, value, or both for the specified inventoryTotal.


 Enum: "quantity" "quantityAndValue" "value"  
 Example:  "value"
operation
required
string
Specify whether the amount will increase or decrease when the user saves the transaction.


 Enum: "add" "subtract"  
 Example:  "add"
required
object
Specify the inventory total that will be affected by the transaction.


 
key
string
System-assigned key for the inventory total.


 
 Example:  "45"
id
string
ID for the inventory total.


 
 Example:  "ONHAND"
object
Purchasing transaction definition associated with this inventory total detail.


 
key
required
string  <= 8 characters 
System-assigned key for the purchasing transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
ID for the purchasing transaction definition.


 
 Example:  "Purchase Quote"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "inventoryTotal": {
    • "id": "DAMAGED"
    },
  • "maintainType": "quantity",
  • "operation": "add"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "191",
    • "id": "191",
    • "href": "/objects/purchasing/txn-definition-inventory-total-detail/191"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a transaction definition inventory total detail object
get/objects/purchasing/txn-definition-inventory-total-detail/{key}
Returns detailed information for a specified transaction definition inventory total detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition inventory total detail object.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "191",
    • "key": "191",
    • "purchasingTxnDefinition": {
      • "key": "96",
      • "id": "Purchase Order",
      • "href": "/objects/purchasing/txn-definition/96"
      },
    • "maintainType": "quantity",
    • "inventoryTotal": {
      • "id": "DAMAGED",
      • "key": "55",
      • "href": "/objects/inventory-control/total/55"
      },
    • "operation": "add",
    • "href": "/objects/purchasing/txn-definition-inventory-total-detail/191"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a transaction definition inventory total detail object
patch/objects/purchasing/txn-definition-inventory-total-detail/{key}
Updates an existing transaction definition inventory total detail object by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition inventory total detail object.


 
 Example:  99
Request Body schema: application/json
maintainType
string
Specify whether to track the quantity, value, or both for the specified inventoryTotal.


 Enum: "quantity" "quantityAndValue" "value"  
 Example:  "value"
operation
string
Specify whether the amount will increase or decrease when the user saves the transaction.


 Enum: "add" "subtract"  
 Example:  "add"
object
Specify the inventory total that will be affected by the transaction.


 
key
string
System-assigned key for the inventory total.


 
 Example:  "45"
id
string
ID for the inventory total.


 
 Example:  "ONHAND"
object
Purchasing transaction definition associated with this inventory total detail.


 
key
string  <= 8 characters 
System-assigned key for the purchasing transaction definition.


 
 Example:  "77"
id
string  <= 30 characters 
ID for the purchasing transaction definition.


 
 Example:  "Purchase Quote"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "purchasingTxnDefinition": {
    • "key": "96"
    },
  • "operation": "subtract"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "192",
    • "id": "192",
    • "href": "/objects/purchasing/txn-definition-inventory-total-detail/192"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a transaction definition inventory total detail object
delete/objects/purchasing/txn-definition-inventory-total-detail/{key}
Deletes a transaction definition inventory total detail object.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the transaction definition inventory total detail object.


 
 Example:  99
Responses 
204
No Content


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
    }
}
Query transaction definition inventory total details
post/services/core/query
Use the query service to find transaction definition inventory total details 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
    }
}