Unit of measure groups

Unit of measure group are provided for items handled under Inventory Control, Order Entry, and Purchasing. Intacct places related units of measure into groups. For example, the Count group includes related units of each, pair, and dozen. The unit of measure (UOM) groups that are provided with Sage Intacct cannot be deleted. Use the Sage Intacct UOM groups as is and create custom UOM groups. For more information, see About unit of measure groups.

List all unit of measure groups

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

Returns up to 100 object references from the collection with a key, ID, and link for each unit of measure group. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "17",
      • "id": "Data storage",
      • "href": "/objects/inventory-control/unit-of-measure-group/17"
      },
    • {
      • "key": "11",
      • "id": "Count",
      • "href": "/objects/inventory-control/unit-of-measure-group/11"
      },
    • {
      • "key": "12",
      • "id": "Length",
      • "href": "/objects/inventory-control/unit-of-measure-group/12"
      },
    • {
      • "key": "13",
      • "id": "Weight",
      • "href": "/objects/inventory-control/unit-of-measure-group/13"
      },
    • {
      • "key": "14",
      • "id": "Volume",
      • "href": "/objects/inventory-control/unit-of-measure-group/14"
      },
    • {
      • "key": "15",
      • "id": "Area",
      • "href": "/objects/inventory-control/unit-of-measure-group/15"
      },
    • {
      • "key": "16",
      • "id": "Time",
      • "href": "/objects/inventory-control/unit-of-measure-group/16"
      }
    ],
  • "ia::meta": {
    • "totalCount": 7,
    • "start": 1,
    • "pageSize": 100
    }
}
Create a unit of measure group
post/objects/inventory-control/unit-of-measure-group
Creates a new custom unit of measure group.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
id
required
string
Name of the unit of measure group.


 
 Example:  "Time"
baseUnit
required
string
Base unit for the group. The base unit is the smallest reasonable unit for pricing within the unit of measure group.


 
 Example:  "Seconds"
abbreviation
string
Abbreviation for the base unit.


 
 Example:  "SEC"
Array of objects
Related units of measure included in the group.


 
 Array 
id
string
Unique identifier for this unit of measure.


 
 Example:  "Hours"
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.


 
conversionFactor
number  <= 30 characters 
Number of base units for this unit of measure.


 
 Example:  2.5
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Data storage",
  • "baseUnit": "Gigabytes",
  • "abbreviation": "GB",
  • "unitsOfMeasure": [
    • {
      • "id": "Terabytes",
      • "abbreviation": "TB",
      • "conversionFactor": 1000,
      • "numberOfDecimalPlaces": 2
      },
    • {
      • "id": "Petabytes",
      • "abbreviation": "PB",
      • "conversionFactor": 100000,
      • "numberOfDecimalPlaces": 2
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "17",
    • "id": "Data storage",
    • "href": "/objects/inventory-control/unit-of-measure-group/17"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a unit of measure group
get/objects/inventory-control/unit-of-measure-group/{key}
Returns detailed information for a specified unit of measure group.


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


 
 Example:  11
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "key": "11",
  • "id": "Count",
  • "baseUnit": "Each",
  • "abbreviation": null,
  • "isSystemGenerated": false,
  • "defaults": {
    • "inventory": {
      • "key": "13",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/13"
      },
    • "purchaseOrder": {
      • "key": "13",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/13"
      },
    • "orderEntry": {
      • "key": "13",
      • "id": "Each",
      • "href": "/objects/inventory-control/unit-of-measure/13"
      }
    },
  • "unitsOfMeasure": [
    • {
      • "key": "13",
      • "id": "Each",
      • "abbreviation": null,
      • "numberOfDecimalPlaces": null,
      • "isBase": true,
      • "parent": {
        },
      • "conversionFactor": 1,
      • "href": "/objects/inventory-control/unit-of-measure/13"
      },
    • {
      • "key": "14",
      • "id": "Pair",
      • "abbreviation": null,
      • "numberOfDecimalPlaces": null,
      • "isBase": false,
      • "parent": {
        },
      • "conversionFactor": 2,
      • "href": "/objects/inventory-control/unit-of-measure/14"
      },
    • {
      • "key": "15",
      • "id": "Dozen",
      • "abbreviation": null,
      • "numberOfDecimalPlaces": null,
      • "isBase": false,
      • "parent": {
        },
      • "conversionFactor": 12,
      • "href": "/objects/inventory-control/unit-of-measure/15",
      • "audit": {
        }
      }
    ],
  • "href": "/objects/inventory-control/unit-of-measure-group/11",
  • "audit": {
    • "createdDateTime": "2014-01-08T11:28:12Z",
    • "modifiedDateTime": "2014-01-08T11:28:12Z",
    • "createdBy": "1",
    • "modifiedBy": "95"
    }
}
Update a unit of measure group
patch/objects/inventory-control/unit-of-measure-group/{key}
Updates an existing unit of measure group by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  11
Request Body schema: application/json
baseUnit
string
Base unit for the group. The base unit is the smallest reasonable unit for pricing within the unit of measure group.


 
 Example:  "Seconds"
abbreviation
string
Abbreviation for the base unit.


 
 Example:  "SEC"
object
Default unit of measure for Inventory, Order Entry, and Purchasing transactions. This is the default unit within a unit of measure group for transactions that contain items associated with the group.
For example, Count is a standard unit of measure group with Each, Pair, and Dozen defined as related units. The Each unit can be set to be the default unit for inventory transactions. 
For more information, see Unit of measure groups.


 
object
Default unit of measure for Inventory transactions.


 
key
string
System-assigned key for the default unit of measure for Inventory transactions.


 
 Example:  "3"
id
string
Id for the default unit of measure for Inventory transactions.


 
 Example:  "Each"
object
Default unit of measure for Purchasing transactions.


 
key
string
System-assigned key for the default unit of measure for Purchasing transactions.


 
 Example:  "3"
id
string
Id for the default unit of measure for Purchasing transactions.


 
 Example:  "Each"
object
Default unit of measure for Order Entry (Sales) transactions.


 
key
string
System-assigned key for the default unit of measure for Order Entry (Sales) transactions.


 
 Example:  "3"
id
string
Id for the default unit of measure for Order Entry (Sales) transactions.


 
 Example:  "Each"
Array of objects
Related units of measure included in the group.


 
 Array 
id
string
Unique identifier for this unit of measure.


 
 Example:  "Hours"
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.


 
conversionFactor
number  <= 30 characters 
Number of base units for this unit of measure.


 
 Example:  2.5
Responses 
200
OK


Request samples 
application/json
{
  • "defaults": {
    • "inventory": {
      • "key": "3"
      }
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "17",
    • "id": "Data Storage",
    • "href": "/objects/inventory-control/unit-of-measure-group/17"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a unit of measure group
delete/objects/inventory-control/unit-of-measure-group/{key}
Deletes a unit of measure group. Unit of measure groups that come with Sage Intacct such as Length,Time, Area, and Count cannot be deleted. Only custom unit of measure groups that are not in use can be deleted.


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


 
 Example:  11
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
    }
}