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.

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.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
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.


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.


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.


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
    }
}