Units of measure

Details for a unit of measure included in a unit of measure group. Sage Intacct places related units of measure into groups. For example, the Count group includes related units of measure such as each, pair, and dozen. For more information, see About unit of measure groups.

List unit of measure objects

get/objects/inventory-control/unit-of-measure

Returns a collection with a key, ID, and link for each unit of measure. This operation is mostly for use in testing; use the query service to find units of measure that meet certain criteria and to specify the properties that you want in the response.

Permissions and other requirements
SubscriptionInventory Control, Order Entry, or Purchasing
User typeBusiness, CRM, Employee, Warehouse
PermissionsList, View Units of Measure
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "135",
      • "id": "GigaBytes",
      • "href": "/objects/inventory-control/unit-of-measure/135"
      },
    • {
      • "key": "136",
      • "id": "KiloBytes",
      • "href": "/objects/inventory-control/unit-of-measure/136"
      },
    • {
      • "key": "137",
      • "id": "MegaBytes",
      • "href": "/objects/inventory-control/unit-of-measure/137"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a unit of measure
post/objects/inventory-control/unit-of-measure
Create one or more custom units of measure within an existing unit of measure group.



Permissions and other requirements



SubscriptionInventory Control, Order Entry, or Purchasing


ConfigurationInventory Control, Order Entry, Purchasing must be enabled for custom units of measure to add, edit, or delete units of measure.


User typeBusiness


PermissionsList, View, Add Units of Measure







SecurityOAuth2 
Request 
Request Body schema: application/json
id
required
string
Unique identifier for this unit of measure.


 
 Example:  "Hours"
required
object
Name of the unit of measure group that includes this unit.


 
id
string
Name of the parent unit of measure group.


 
 Example:  "ComputerStorage"
conversionFactor
required
number  <= 30 characters 
Number of base units for this unit of measure.


 
 Example:  2.5
abbreviation
string
Unique abbreviation for this unit of measure.


 
 Example:  "HR"
numberOfDecimalPlaces
integer  <= 1 characters 
Allowed number of decimal places for this unit of measure. should be integer less than 4


 
 Example:  2
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "GigaBytes",
  • "abbreviation": "GB",
  • "numberOfDecimalPlaces": 0,
  • "parent": {
    • "key": "17"
    },
  • "conversionFactor": 1024
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "135",
    • "href": "/objects/unit-of-measure/135"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a unit of measure
get/objects/inventory-control/unit-of-measure/{key}
Returns detailed information for a specified unit of measure.



Permissions and other requirements



SubscriptionInventory Control, Order Entry, or Purchasing


User typeBusiness, CRM, Employee, Warehouse


PermissionsList, View Units of Measure







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the unit of measure.


 
 Example:  135
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "135",
    • "id": "GigaBytes",
    • "abbreviation": "GB",
    • "parent": {
      • "key": "17",
      • "id": "ComputerStorage",
      • "href": "/objects/inventory-control-unit-of-measure/17"
      },
    • "conversionFactor": 1024,
    • "numberOfDecimalPlaces": 0,
    • "isBase": false,
    • "audit": {
      • "createdDateTime": "2021-09-15T16:46:11Z",
      • "modifiedDateTime": "2021-09-15T16:46:11Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/inventory-control/unit-of-measure/135"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a unit of measure
patch/objects/inventory-control/unit-of-measure/{key}
Updates an existing custom unit of measure by setting field values. Any fields not provided remain unchanged. Units of measure already in use cannot be modified.



Permissions and other requirements



SubscriptionInventory Control, Order Entry, or Purchasing


ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete units of measure.


User typeBusiness


PermissionsList, View, Edit Units of Measure







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the unit of measure.


 
 Example:  135
Request Body schema: application/json
abbreviation
string
Unique abbreviation for this unit of measure.


 
 Example:  "HR"
numberOfDecimalPlaces
integer  <= 1 characters 
Allowed number of decimal places for this unit of measure. should be integer less than 4


 
 Example:  2
object
Name of the unit of measure group that includes this unit.


 
id
string
Name of the parent unit of measure group.


 
 Example:  "ComputerStorage"
conversionFactor
number  <= 30 characters 
Number of base units for this unit of measure.


 
 Example:  2.5
Responses 
200
OK


Request samples 
application/json
{
  • "abbreviation": "GB"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "135",
    • "href": "/objects/inventory-control/unit-of-measure/135"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a unit of measure
delete/objects/inventory-control/unit-of-measure/{key}
Deletes a unit of measure. Units of measure that are provided with Sage Intacct and included in default unit of measure groups such as Time, Area, and Count cannot be deleted. Only custom units of measure that are not in use can be deleted.



Permissions and other requirements



SubscriptionInventory Control, Order Entry, or Purchasing


ConfigurationInventory Control, Order Entry, or Purchasing must be enabled for custom units of measure to add, edit, or delete unit of measure groups.


User typeBusiness


PermissionsList, View, Delete Units of Measure







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the unit of measure.


 
 Example:  135
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 unit of measures
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/unit-of-measure"
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 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 response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "inventory-control/unit-of-measure",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "7",
      • "id": "Days",
      • "href": "/objects/inventory-control/unit-of-measure/7"
      },
    • {
      • "key": "13",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/13"
      },
    • {
      • "key": "85",
      • "id": "Gigabytes",
      • "href": "/objects/inventory-control/unit-of-measure/85"
      },
    • {
      • "key": "16",
      • "id": "Inch",
      • "href": "/objects/inventory-control/unit-of-measure/16"
      },
    • {
      • "key": "24",
      • "id": "Ounce",
      • "href": "/objects/inventory-control/unit-of-measure/24"
      },
    • {
      • "key": "61",
      • "id": "Seconds",
      • "href": "/objects/inventory-control/unit-of-measure/61"
      },
    • {
      • "key": "43",
      • "id": "Square Inch",
      • "href": "/objects/inventory-control/unit-of-measure/43"
      },
    • {
      • "key": "30",
      • "id": "Teaspoon",
      • "href": "/objects/inventory-control/unit-of-measure/30"
      }
    ],
  • "ia::meta": {
    • "totalCount": 8,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}