Inventory totals

Use inventory totals to keep track of the items on hand that are available for sale. Sage Intacct is preconfigured with nine inventory totals for tracking inventory that's damaged, in transit, on hand, on hold, on order, requisitioned, or is scrap and spoilage. You can also create your own inventory totals as needed.

An inventory total can be assigned to a transaction definition so that the specified total is affected when a transaction with that definition template is saved. For more information and a detailed example, see Inventory totals in the Sage Intacct Help Center.

List inventory totals

get/objects/inventory-control/total

Returns a collection with a key, ID, and link for each inventory total. 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
SubscriptionInventory Control
User typeBusiness, Employee, Warehouse
PermissionsList, View Inventory totals
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "51",
      • "id": "ONORDER",
      • "href": "/objects/inventory-control/total/51"
      },
    • {
      • "key": "52",
      • "id": "ONHAND",
      • "href": "/objects/inventory-control/total/52"
      },
    • {
      • "key": "53",
      • "id": "ONHOLD",
      • "href": "/objects/inventory-control/total/53"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 101,
    • "previous": null
    }
}
Create an inventory total
post/objects/inventory-control/total
Creates a new inventory total.



Permissions and other requirements



SubscriptionInventory Control


ConfigurationAdvanced workflows must be enabled to add inventory totals


User typeBusiness


PermissionsList, View, Add Inventory totals







SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string  <= 30 characters 
ID of inventory total. This should be a unique value.


 
 Example:  "SHIPPED"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "SHIPPED",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "60",
    • "id": "SHIPPED",
    • "href": "/objects/inventory-control/total/60"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an inventory total
get/objects/inventory-control/total/{key}
Returns detailed information for a specified inventory total.



Permissions and other requirements



SubscriptionInventory Control


User typeBusiness, Employee, Warehouse


PermissionsList, View Inventory totals







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


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "60",
    • "id": "SHIPPED",
    • "status": "active",
    • "updateType": "accumulative",
    • "href": "/objects/inventory-control/total/60"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update an inventory total
patch/objects/inventory-control/total/{key}
Updates an existing inventory total by setting field values. Any fields not provided remain unchanged.
User-defined totals can be edited, but only the status of preset inventory totals can be edited. To prevent a preset inventory total from being selected in a transaction definition, change its status to inactive.



Permissions and other requirements



SubscriptionInventory Control


ConfigurationAdvanced workflows must be enabled to edit inventory totals


User typeBusiness


PermissionsList, View, Edit Inventory totals







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


 
 Example:  99
Request Body schema: application/json
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "60",
    • "id": "SHIPPED",
    • "href": "/objects/inventory-control/total/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an inventory total
delete/objects/inventory-control/total/{key}
Deletes an inventory total. Only user-defined inventory totals can be deleted.



Permissions and other requirements



SubscriptionInventory Control


ConfigurationAdvanced workflows must be enabled to delete inventory totals


User typeBusiness


PermissionsList, View, Delete Inventory totals







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


 
 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 totals
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "inventory-control/total"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or has (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/total",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "id",
    • "updateType",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "DAMAGED",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/91"
      },
    • {
      • "id": "INTRANSIT",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/93"
      },
    • {
      • "id": "ONHAND",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/2"
      },
    • {
      • "id": "ONHOLD",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/3"
      },
    • {
      • "id": "ONORDER",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/1"
      },
    • {
      • "id": "REQUESITIONED",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/40"
      },
    • {
      • "id": "RESERVED",
      • "updateType": "continuous",
      • "href": "/objects/inventory-control/total/97"
      },
    • {
      • "id": "SCRAP OR SPOILAGE",
      • "updateType": "accumulative",
      • "href": "/objects/inventory-control/total/92"
      }
    ],
  • "ia::meta": {
    • "totalCount": 8,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}