The UOM object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

uom_name string required
must_be_whole_number boolean

Default: false

enabled boolean

Default: true

symbol string
common_code string
description string
The UOM object 
{
  "id": "u-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "uom_name": "uom_name_example",
  "must_be_whole_number": false,
  "enabled": true,
  "symbol": "symbol_example",
  "common_code": "common_code_example",
  "description": "description_example"
}
GET /api/setup/u-o-m/{id}

Retrieve a uom

Retrieves the details of an existing uom. Supply the unique uom ID that was returned from a previous request.

Path parameters

id string required

The identifier of the uom to retrieve.

Returns

Returns the uom object if a valid identifier was provided.

GET /api/setup/u-o-m/{id} 
curl https://api.overplane.dev/api/setup/u-o-m/u-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "u-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "uom_name": "uom_name_example",
  "must_be_whole_number": false,
  "enabled": true,
  "symbol": "symbol_example",
  "common_code": "common_code_example",
  "description": "description_example"
}
GET /api/setup/u-o-m

List all uoms

Returns a list of uoms. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of uom objects.

GET /api/setup/u-o-m 
curl https://api.overplane.dev/api/setup/u-o-m \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "u-o-m_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "uom_name": "uom_name_example",
      "must_be_whole_number": false,
      "enabled": true,
      "symbol": "symbol_example",
      "common_code": "common_code_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/u-o-m

Create a uom

Creates a new uom object.

Body parameters

uom_name string required
must_be_whole_number boolean

Default: false

enabled boolean

Default: true

symbol string
common_code string
description string

Returns

Returns the newly created uom object if the call succeeded.

POST /api/setup/u-o-m 
curl https://api.overplane.dev/api/setup/u-o-m \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"uom_name":"uom_name_example"}'
Response 
{
  "id": "u-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "uom_name": "uom_name_example",
  "must_be_whole_number": false,
  "enabled": true,
  "symbol": "symbol_example",
  "common_code": "common_code_example",
  "description": "description_example"
}
PATCH /api/setup/u-o-m/{id}

Update a uom

Updates the specified uom by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the uom to update.

Body parameters

uom_name string
must_be_whole_number boolean

Default: false

enabled boolean

Default: true

symbol string
common_code string
description string

Returns

Returns the updated uom object.

PATCH /api/setup/u-o-m/{id} 
curl https://api.overplane.dev/api/setup/u-o-m/u-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"uom_name":"uom_name_example","must_be_whole_number":false}'
Response 
{
  "id": "u-o-m_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "uom_name": "uom_name_example",
  "must_be_whole_number": false,
  "enabled": true,
  "symbol": "symbol_example",
  "common_code": "common_code_example",
  "description": "description_example"
}
DELETE /api/setup/u-o-m/{id}

Delete a uom

Permanently deletes a uom. This cannot be undone.

Path parameters

id string required

The identifier of the uom to delete.

Returns

Returns a confirmation that the uom has been deleted.

DELETE /api/setup/u-o-m/{id} 
curl https://api.overplane.dev/api/setup/u-o-m/u-o-m_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "u-o-m_abc123",
  "deleted": true
}