UnitsOfMeasurements

This feature is currently under development and, although not available in the current version, its preliminary documentation is provided to give you a preview of the enhancements that will be included in an upcoming update.

HTTP Operation Type Object
Query unitsOfMeasurements filtered by id Why?
Query unitsOfMeasurements

Description

Represents the various units of measurement known as UnitsOfMeasurements in the API context and used for defining product quantities in the product interface.
Each unit of measurement is associated with a specific Product Category and includes metadata such as Abbreviation, Number of Decimals, and Name to provide detailed descriptions for quantities.
The units of measurement are crucial for ensuring accuracy in product inventory and pricing calculations.

img

Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id How to find?
X-OrganizationId Current organization Id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

unitsOfMeasurements

Fields Type Description
id UUID Id
     
active Boolean Indicates if active
category
  • NOT_SPECIFIED
  • PRODUCTS
  • SERVICES
  • PRODUCTS_AND_SERVICES
 Product Category
unitOfMeasurementDetails Unit of measurement Detail Fields of Unit of Measurement Detail
  • id
 UUID Unit of Measurement Detail ID
  • numberOfDecimals
 Integer Number of decimals
  • name
  • NOT_UNIT
  • CUBIC_METRE
  • DAY
  • GRAM
  • HOUR
  • KILOGRAM
  • KILOMETRE
  • LITRE
  • METRE
  • MILLIGRAM
  • MILLILITRE
  • MONTH
  • NIGHT
  • PACK
  • PERCENTAGE
  • SQUARE_METRE
  • TONNE
  • UNIT
 Enum for Name and Abbreviations
unitOfMeasurementDetailsId UUID Unit of Measurement Detail ID
Info
  • Active:
    Enables or disables the use of a unit of measurement.
    This setting can be configured from the Settings interface in Sage Active.
  • Category:
    Indicates whether a unit of measurement is available for a Product-type item, a Service-type item, or both.
    This setting can also be configured from the Settings interface.
  • UnitOfMeasurementDetails:
    Represents the details of a unit of measurement, including the fields id, numberOfDecimals, and name. These values are non-editable.
    The number of decimals specifies the precision for quantities entered in sales documents.

  • Name - Abbreviations:
    As the API returns enumeration values but does not return their localized translations, unitsOfMeasurements does not return the abbreviations, which, like the unit labels, are localizations of the enumerations.

    Below are the English abbreviations values for each unit:

    • NOT_UNIT:  
    • CUBIC_METRE:  m³
    • DAY:  DAYS
    • GRAM:  G
    • HOUR:  HR
    • KILOGRAM:  KG
    • KILOMETRE:  KM
    • LITRE:  L
    • METRE:  M
    • MILLIGRAM:  MG
    • MILLILITRE:  ML
    • MONTH:  MONTHS
    • NIGHT:  NIGHTS
    • PACK:  PACKS
    • PERCENTAGE:  %
    • SQUARE_METRE:  M²
    • TONNE:  T
    • UNIT:  UNITS